Documentation ¶
Index ¶
- func CfnAppImageConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAppImageConfig_IsCfnElement(x interface{}) *bool
- func CfnAppImageConfig_IsCfnResource(x interface{}) *bool
- func CfnAppImageConfig_IsConstruct(x interface{}) *bool
- func CfnApp_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApp_IsCfnElement(x interface{}) *bool
- func CfnApp_IsCfnResource(x interface{}) *bool
- func CfnApp_IsConstruct(x interface{}) *bool
- func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCluster_IsCfnElement(x interface{}) *bool
- func CfnCluster_IsCfnResource(x interface{}) *bool
- func CfnCluster_IsConstruct(x interface{}) *bool
- func CfnCodeRepository_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCodeRepository_IsCfnElement(x interface{}) *bool
- func CfnCodeRepository_IsCfnResource(x interface{}) *bool
- func CfnCodeRepository_IsConstruct(x interface{}) *bool
- func CfnDataQualityJobDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataQualityJobDefinition_IsCfnElement(x interface{}) *bool
- func CfnDataQualityJobDefinition_IsCfnResource(x interface{}) *bool
- func CfnDataQualityJobDefinition_IsConstruct(x interface{}) *bool
- func CfnDeviceFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeviceFleet_IsCfnElement(x interface{}) *bool
- func CfnDeviceFleet_IsCfnResource(x interface{}) *bool
- func CfnDeviceFleet_IsConstruct(x interface{}) *bool
- func CfnDevice_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDevice_IsCfnElement(x interface{}) *bool
- func CfnDevice_IsCfnResource(x interface{}) *bool
- func CfnDevice_IsConstruct(x interface{}) *bool
- func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomain_IsCfnElement(x interface{}) *bool
- func CfnDomain_IsCfnResource(x interface{}) *bool
- func CfnDomain_IsConstruct(x interface{}) *bool
- func CfnEndpointConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEndpointConfig_IsCfnElement(x interface{}) *bool
- func CfnEndpointConfig_IsCfnResource(x interface{}) *bool
- func CfnEndpointConfig_IsConstruct(x interface{}) *bool
- func CfnEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEndpoint_IsCfnElement(x interface{}) *bool
- func CfnEndpoint_IsCfnResource(x interface{}) *bool
- func CfnEndpoint_IsConstruct(x interface{}) *bool
- func CfnFeatureGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFeatureGroup_IsCfnElement(x interface{}) *bool
- func CfnFeatureGroup_IsCfnResource(x interface{}) *bool
- func CfnFeatureGroup_IsConstruct(x interface{}) *bool
- func CfnImageVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnImageVersion_IsCfnElement(x interface{}) *bool
- func CfnImageVersion_IsCfnResource(x interface{}) *bool
- func CfnImageVersion_IsConstruct(x interface{}) *bool
- func CfnImage_CFN_RESOURCE_TYPE_NAME() *string
- func CfnImage_IsCfnElement(x interface{}) *bool
- func CfnImage_IsCfnResource(x interface{}) *bool
- func CfnImage_IsConstruct(x interface{}) *bool
- func CfnInferenceComponent_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInferenceComponent_IsCfnElement(x interface{}) *bool
- func CfnInferenceComponent_IsCfnResource(x interface{}) *bool
- func CfnInferenceComponent_IsConstruct(x interface{}) *bool
- func CfnInferenceExperiment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInferenceExperiment_IsCfnElement(x interface{}) *bool
- func CfnInferenceExperiment_IsCfnResource(x interface{}) *bool
- func CfnInferenceExperiment_IsConstruct(x interface{}) *bool
- func CfnMlflowTrackingServer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMlflowTrackingServer_IsCfnElement(x interface{}) *bool
- func CfnMlflowTrackingServer_IsCfnResource(x interface{}) *bool
- func CfnMlflowTrackingServer_IsConstruct(x interface{}) *bool
- func CfnModelBiasJobDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelBiasJobDefinition_IsCfnElement(x interface{}) *bool
- func CfnModelBiasJobDefinition_IsCfnResource(x interface{}) *bool
- func CfnModelBiasJobDefinition_IsConstruct(x interface{}) *bool
- func CfnModelCard_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelCard_IsCfnElement(x interface{}) *bool
- func CfnModelCard_IsCfnResource(x interface{}) *bool
- func CfnModelCard_IsConstruct(x interface{}) *bool
- func CfnModelExplainabilityJobDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelExplainabilityJobDefinition_IsCfnElement(x interface{}) *bool
- func CfnModelExplainabilityJobDefinition_IsCfnResource(x interface{}) *bool
- func CfnModelExplainabilityJobDefinition_IsConstruct(x interface{}) *bool
- func CfnModelPackageGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelPackageGroup_IsCfnElement(x interface{}) *bool
- func CfnModelPackageGroup_IsCfnResource(x interface{}) *bool
- func CfnModelPackageGroup_IsConstruct(x interface{}) *bool
- func CfnModelPackage_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelPackage_IsCfnElement(x interface{}) *bool
- func CfnModelPackage_IsCfnResource(x interface{}) *bool
- func CfnModelPackage_IsConstruct(x interface{}) *bool
- func CfnModelQualityJobDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModelQualityJobDefinition_IsCfnElement(x interface{}) *bool
- func CfnModelQualityJobDefinition_IsCfnResource(x interface{}) *bool
- func CfnModelQualityJobDefinition_IsConstruct(x interface{}) *bool
- func CfnModel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModel_IsCfnElement(x interface{}) *bool
- func CfnModel_IsCfnResource(x interface{}) *bool
- func CfnModel_IsConstruct(x interface{}) *bool
- func CfnMonitoringSchedule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMonitoringSchedule_IsCfnElement(x interface{}) *bool
- func CfnMonitoringSchedule_IsCfnResource(x interface{}) *bool
- func CfnMonitoringSchedule_IsConstruct(x interface{}) *bool
- func CfnNotebookInstanceLifecycleConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNotebookInstanceLifecycleConfig_IsCfnElement(x interface{}) *bool
- func CfnNotebookInstanceLifecycleConfig_IsCfnResource(x interface{}) *bool
- func CfnNotebookInstanceLifecycleConfig_IsConstruct(x interface{}) *bool
- func CfnNotebookInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNotebookInstance_IsCfnElement(x interface{}) *bool
- func CfnNotebookInstance_IsCfnResource(x interface{}) *bool
- func CfnNotebookInstance_IsConstruct(x interface{}) *bool
- func CfnPipeline_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPipeline_IsCfnElement(x interface{}) *bool
- func CfnPipeline_IsCfnResource(x interface{}) *bool
- func CfnPipeline_IsConstruct(x interface{}) *bool
- func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProject_IsCfnElement(x interface{}) *bool
- func CfnProject_IsCfnResource(x interface{}) *bool
- func CfnProject_IsConstruct(x interface{}) *bool
- func CfnSpace_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSpace_IsCfnElement(x interface{}) *bool
- func CfnSpace_IsCfnResource(x interface{}) *bool
- func CfnSpace_IsConstruct(x interface{}) *bool
- func CfnStudioLifecycleConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStudioLifecycleConfig_IsCfnElement(x interface{}) *bool
- func CfnStudioLifecycleConfig_IsCfnResource(x interface{}) *bool
- func CfnStudioLifecycleConfig_IsConstruct(x interface{}) *bool
- func CfnUserProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserProfile_IsCfnElement(x interface{}) *bool
- func CfnUserProfile_IsCfnResource(x interface{}) *bool
- func CfnUserProfile_IsConstruct(x interface{}) *bool
- func CfnWorkteam_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkteam_IsCfnElement(x interface{}) *bool
- func CfnWorkteam_IsCfnResource(x interface{}) *bool
- func CfnWorkteam_IsConstruct(x interface{}) *bool
- func NewCfnAppImageConfig_Override(c CfnAppImageConfig, scope constructs.Construct, id *string, ...)
- func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
- func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
- func NewCfnCodeRepository_Override(c CfnCodeRepository, scope constructs.Construct, id *string, ...)
- func NewCfnDataQualityJobDefinition_Override(c CfnDataQualityJobDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnDeviceFleet_Override(c CfnDeviceFleet, scope constructs.Construct, id *string, ...)
- func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)
- func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
- func NewCfnEndpointConfig_Override(c CfnEndpointConfig, scope constructs.Construct, id *string, ...)
- func NewCfnEndpoint_Override(c CfnEndpoint, scope constructs.Construct, id *string, props *CfnEndpointProps)
- func NewCfnFeatureGroup_Override(c CfnFeatureGroup, scope constructs.Construct, id *string, ...)
- func NewCfnImageVersion_Override(c CfnImageVersion, scope constructs.Construct, id *string, ...)
- func NewCfnImage_Override(c CfnImage, scope constructs.Construct, id *string, props *CfnImageProps)
- func NewCfnInferenceComponent_Override(c CfnInferenceComponent, scope constructs.Construct, id *string, ...)
- func NewCfnInferenceExperiment_Override(c CfnInferenceExperiment, scope constructs.Construct, id *string, ...)
- func NewCfnMlflowTrackingServer_Override(c CfnMlflowTrackingServer, scope constructs.Construct, id *string, ...)
- func NewCfnModelBiasJobDefinition_Override(c CfnModelBiasJobDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnModelCard_Override(c CfnModelCard, scope constructs.Construct, id *string, ...)
- func NewCfnModelExplainabilityJobDefinition_Override(c CfnModelExplainabilityJobDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnModelPackageGroup_Override(c CfnModelPackageGroup, scope constructs.Construct, id *string, ...)
- func NewCfnModelPackage_Override(c CfnModelPackage, scope constructs.Construct, id *string, ...)
- func NewCfnModelQualityJobDefinition_Override(c CfnModelQualityJobDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnModel_Override(c CfnModel, scope constructs.Construct, id *string, props *CfnModelProps)
- func NewCfnMonitoringSchedule_Override(c CfnMonitoringSchedule, scope constructs.Construct, id *string, ...)
- func NewCfnNotebookInstanceLifecycleConfig_Override(c CfnNotebookInstanceLifecycleConfig, scope constructs.Construct, id *string, ...)
- func NewCfnNotebookInstance_Override(c CfnNotebookInstance, scope constructs.Construct, id *string, ...)
- func NewCfnPipeline_Override(c CfnPipeline, scope constructs.Construct, id *string, props *CfnPipelineProps)
- func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
- func NewCfnSpace_Override(c CfnSpace, scope constructs.Construct, id *string, props *CfnSpaceProps)
- func NewCfnStudioLifecycleConfig_Override(c CfnStudioLifecycleConfig, scope constructs.Construct, id *string, ...)
- func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, ...)
- func NewCfnWorkteam_Override(c CfnWorkteam, scope constructs.Construct, id *string, props *CfnWorkteamProps)
- type CfnApp
- type CfnAppImageConfig
- type CfnAppImageConfigProps
- type CfnAppImageConfig_CodeEditorAppImageConfigProperty
- type CfnAppImageConfig_ContainerConfigProperty
- type CfnAppImageConfig_CustomImageContainerEnvironmentVariableProperty
- type CfnAppImageConfig_FileSystemConfigProperty
- type CfnAppImageConfig_JupyterLabAppImageConfigProperty
- type CfnAppImageConfig_KernelGatewayImageConfigProperty
- type CfnAppImageConfig_KernelSpecProperty
- type CfnAppProps
- type CfnApp_ResourceSpecProperty
- type CfnCluster
- type CfnClusterProps
- type CfnCluster_ClusterEbsVolumeConfigProperty
- type CfnCluster_ClusterInstanceGroupProperty
- type CfnCluster_ClusterInstanceStorageConfigProperty
- type CfnCluster_ClusterLifeCycleConfigProperty
- type CfnCluster_ClusterOrchestratorEksConfigProperty
- type CfnCluster_OrchestratorProperty
- type CfnCluster_VpcConfigProperty
- type CfnCodeRepository
- type CfnCodeRepositoryProps
- type CfnCodeRepository_GitConfigProperty
- type CfnDataQualityJobDefinition
- type CfnDataQualityJobDefinitionProps
- type CfnDataQualityJobDefinition_BatchTransformInputProperty
- type CfnDataQualityJobDefinition_ClusterConfigProperty
- type CfnDataQualityJobDefinition_ConstraintsResourceProperty
- type CfnDataQualityJobDefinition_CsvProperty
- type CfnDataQualityJobDefinition_DataQualityAppSpecificationProperty
- type CfnDataQualityJobDefinition_DataQualityBaselineConfigProperty
- type CfnDataQualityJobDefinition_DataQualityJobInputProperty
- type CfnDataQualityJobDefinition_DatasetFormatProperty
- type CfnDataQualityJobDefinition_EndpointInputProperty
- type CfnDataQualityJobDefinition_JsonProperty
- type CfnDataQualityJobDefinition_MonitoringOutputConfigProperty
- type CfnDataQualityJobDefinition_MonitoringOutputProperty
- type CfnDataQualityJobDefinition_MonitoringResourcesProperty
- type CfnDataQualityJobDefinition_NetworkConfigProperty
- type CfnDataQualityJobDefinition_S3OutputProperty
- type CfnDataQualityJobDefinition_StatisticsResourceProperty
- type CfnDataQualityJobDefinition_StoppingConditionProperty
- type CfnDataQualityJobDefinition_VpcConfigProperty
- type CfnDevice
- type CfnDeviceFleet
- type CfnDeviceFleetProps
- type CfnDeviceFleet_EdgeOutputConfigProperty
- type CfnDeviceProps
- type CfnDevice_DeviceProperty
- type CfnDomain
- type CfnDomainProps
- type CfnDomain_CodeEditorAppSettingsProperty
- type CfnDomain_CodeRepositoryProperty
- type CfnDomain_CustomFileSystemConfigProperty
- type CfnDomain_CustomImageProperty
- type CfnDomain_CustomPosixUserConfigProperty
- type CfnDomain_DefaultEbsStorageSettingsProperty
- type CfnDomain_DefaultSpaceSettingsProperty
- type CfnDomain_DefaultSpaceStorageSettingsProperty
- type CfnDomain_DockerSettingsProperty
- type CfnDomain_DomainSettingsProperty
- type CfnDomain_EFSFileSystemConfigProperty
- type CfnDomain_JupyterLabAppSettingsProperty
- type CfnDomain_JupyterServerAppSettingsProperty
- type CfnDomain_KernelGatewayAppSettingsProperty
- type CfnDomain_RSessionAppSettingsProperty
- type CfnDomain_RStudioServerProAppSettingsProperty
- type CfnDomain_RStudioServerProDomainSettingsProperty
- type CfnDomain_ResourceSpecProperty
- type CfnDomain_SharingSettingsProperty
- type CfnDomain_StudioWebPortalSettingsProperty
- type CfnDomain_UserSettingsProperty
- type CfnEndpoint
- type CfnEndpointConfig
- type CfnEndpointConfigProps
- type CfnEndpointConfig_AsyncInferenceClientConfigProperty
- type CfnEndpointConfig_AsyncInferenceConfigProperty
- type CfnEndpointConfig_AsyncInferenceNotificationConfigProperty
- type CfnEndpointConfig_AsyncInferenceOutputConfigProperty
- type CfnEndpointConfig_CaptureContentTypeHeaderProperty
- type CfnEndpointConfig_CaptureOptionProperty
- type CfnEndpointConfig_ClarifyExplainerConfigProperty
- type CfnEndpointConfig_ClarifyInferenceConfigProperty
- type CfnEndpointConfig_ClarifyShapBaselineConfigProperty
- type CfnEndpointConfig_ClarifyShapConfigProperty
- type CfnEndpointConfig_ClarifyTextConfigProperty
- type CfnEndpointConfig_DataCaptureConfigProperty
- type CfnEndpointConfig_ExplainerConfigProperty
- type CfnEndpointConfig_ManagedInstanceScalingProperty
- type CfnEndpointConfig_ProductionVariantProperty
- type CfnEndpointConfig_RoutingConfigProperty
- type CfnEndpointConfig_ServerlessConfigProperty
- type CfnEndpointConfig_VpcConfigProperty
- type CfnEndpointProps
- type CfnEndpoint_AlarmProperty
- type CfnEndpoint_AutoRollbackConfigProperty
- type CfnEndpoint_BlueGreenUpdatePolicyProperty
- type CfnEndpoint_CapacitySizeProperty
- type CfnEndpoint_DeploymentConfigProperty
- type CfnEndpoint_RollingUpdatePolicyProperty
- type CfnEndpoint_TrafficRoutingConfigProperty
- type CfnEndpoint_VariantPropertyProperty
- type CfnFeatureGroup
- type CfnFeatureGroupProps
- type CfnFeatureGroup_DataCatalogConfigProperty
- type CfnFeatureGroup_FeatureDefinitionProperty
- type CfnFeatureGroup_OfflineStoreConfigProperty
- type CfnFeatureGroup_OnlineStoreConfigProperty
- type CfnFeatureGroup_OnlineStoreSecurityConfigProperty
- type CfnFeatureGroup_S3StorageConfigProperty
- type CfnFeatureGroup_ThroughputConfigProperty
- type CfnFeatureGroup_TtlDurationProperty
- type CfnImage
- type CfnImageProps
- type CfnImageVersion
- type CfnImageVersionProps
- type CfnInferenceComponent
- type CfnInferenceComponentProps
- type CfnInferenceComponent_DeployedImageProperty
- type CfnInferenceComponent_InferenceComponentComputeResourceRequirementsProperty
- type CfnInferenceComponent_InferenceComponentContainerSpecificationProperty
- type CfnInferenceComponent_InferenceComponentRuntimeConfigProperty
- type CfnInferenceComponent_InferenceComponentSpecificationProperty
- type CfnInferenceComponent_InferenceComponentStartupParametersProperty
- type CfnInferenceExperiment
- type CfnInferenceExperimentProps
- type CfnInferenceExperiment_CaptureContentTypeHeaderProperty
- type CfnInferenceExperiment_DataStorageConfigProperty
- type CfnInferenceExperiment_EndpointMetadataProperty
- type CfnInferenceExperiment_InferenceExperimentScheduleProperty
- type CfnInferenceExperiment_ModelInfrastructureConfigProperty
- type CfnInferenceExperiment_ModelVariantConfigProperty
- type CfnInferenceExperiment_RealTimeInferenceConfigProperty
- type CfnInferenceExperiment_ShadowModeConfigProperty
- type CfnInferenceExperiment_ShadowModelVariantConfigProperty
- type CfnMlflowTrackingServer
- type CfnMlflowTrackingServerProps
- type CfnModel
- type CfnModelBiasJobDefinition
- type CfnModelBiasJobDefinitionProps
- type CfnModelBiasJobDefinition_BatchTransformInputProperty
- type CfnModelBiasJobDefinition_ClusterConfigProperty
- type CfnModelBiasJobDefinition_ConstraintsResourceProperty
- type CfnModelBiasJobDefinition_CsvProperty
- type CfnModelBiasJobDefinition_DatasetFormatProperty
- type CfnModelBiasJobDefinition_EndpointInputProperty
- type CfnModelBiasJobDefinition_JsonProperty
- type CfnModelBiasJobDefinition_ModelBiasAppSpecificationProperty
- type CfnModelBiasJobDefinition_ModelBiasBaselineConfigProperty
- type CfnModelBiasJobDefinition_ModelBiasJobInputProperty
- type CfnModelBiasJobDefinition_MonitoringGroundTruthS3InputProperty
- type CfnModelBiasJobDefinition_MonitoringOutputConfigProperty
- type CfnModelBiasJobDefinition_MonitoringOutputProperty
- type CfnModelBiasJobDefinition_MonitoringResourcesProperty
- type CfnModelBiasJobDefinition_NetworkConfigProperty
- type CfnModelBiasJobDefinition_S3OutputProperty
- type CfnModelBiasJobDefinition_StoppingConditionProperty
- type CfnModelBiasJobDefinition_VpcConfigProperty
- type CfnModelCard
- type CfnModelCardProps
- type CfnModelCard_AdditionalInformationProperty
- type CfnModelCard_BusinessDetailsProperty
- type CfnModelCard_ContainerProperty
- type CfnModelCard_ContentProperty
- type CfnModelCard_EvaluationDetailProperty
- type CfnModelCard_FunctionProperty
- type CfnModelCard_InferenceEnvironmentProperty
- type CfnModelCard_InferenceSpecificationProperty
- type CfnModelCard_IntendedUsesProperty
- type CfnModelCard_MetricDataItemsProperty
- type CfnModelCard_MetricGroupProperty
- type CfnModelCard_ModelOverviewProperty
- type CfnModelCard_ModelPackageCreatorProperty
- type CfnModelCard_ModelPackageDetailsProperty
- type CfnModelCard_ObjectiveFunctionProperty
- type CfnModelCard_SecurityConfigProperty
- type CfnModelCard_SourceAlgorithmProperty
- type CfnModelCard_TrainingDetailsProperty
- type CfnModelCard_TrainingEnvironmentProperty
- type CfnModelCard_TrainingHyperParameterProperty
- type CfnModelCard_TrainingJobDetailsProperty
- type CfnModelCard_TrainingMetricProperty
- type CfnModelCard_UserContextProperty
- type CfnModelExplainabilityJobDefinition
- type CfnModelExplainabilityJobDefinitionProps
- type CfnModelExplainabilityJobDefinition_BatchTransformInputProperty
- type CfnModelExplainabilityJobDefinition_ClusterConfigProperty
- type CfnModelExplainabilityJobDefinition_ConstraintsResourceProperty
- type CfnModelExplainabilityJobDefinition_CsvProperty
- type CfnModelExplainabilityJobDefinition_DatasetFormatProperty
- type CfnModelExplainabilityJobDefinition_EndpointInputProperty
- type CfnModelExplainabilityJobDefinition_JsonProperty
- type CfnModelExplainabilityJobDefinition_ModelExplainabilityAppSpecificationProperty
- type CfnModelExplainabilityJobDefinition_ModelExplainabilityBaselineConfigProperty
- type CfnModelExplainabilityJobDefinition_ModelExplainabilityJobInputProperty
- type CfnModelExplainabilityJobDefinition_MonitoringOutputConfigProperty
- type CfnModelExplainabilityJobDefinition_MonitoringOutputProperty
- type CfnModelExplainabilityJobDefinition_MonitoringResourcesProperty
- type CfnModelExplainabilityJobDefinition_NetworkConfigProperty
- type CfnModelExplainabilityJobDefinition_S3OutputProperty
- type CfnModelExplainabilityJobDefinition_StoppingConditionProperty
- type CfnModelExplainabilityJobDefinition_VpcConfigProperty
- type CfnModelPackage
- type CfnModelPackageGroup
- type CfnModelPackageGroupProps
- type CfnModelPackageProps
- type CfnModelPackage_AdditionalInferenceSpecificationDefinitionProperty
- type CfnModelPackage_BiasProperty
- type CfnModelPackage_DataSourceProperty
- type CfnModelPackage_DriftCheckBaselinesProperty
- type CfnModelPackage_DriftCheckBiasProperty
- type CfnModelPackage_DriftCheckExplainabilityProperty
- type CfnModelPackage_DriftCheckModelDataQualityProperty
- type CfnModelPackage_DriftCheckModelQualityProperty
- type CfnModelPackage_ExplainabilityProperty
- type CfnModelPackage_FileSourceProperty
- type CfnModelPackage_InferenceSpecificationProperty
- type CfnModelPackage_MetadataPropertiesProperty
- type CfnModelPackage_MetricsSourceProperty
- type CfnModelPackage_ModelAccessConfigProperty
- type CfnModelPackage_ModelCardProperty
- type CfnModelPackage_ModelDataQualityProperty
- type CfnModelPackage_ModelDataSourceProperty
- type CfnModelPackage_ModelInputProperty
- type CfnModelPackage_ModelMetricsProperty
- type CfnModelPackage_ModelPackageContainerDefinitionProperty
- type CfnModelPackage_ModelPackageStatusDetailsProperty
- type CfnModelPackage_ModelPackageStatusItemProperty
- type CfnModelPackage_ModelQualityProperty
- type CfnModelPackage_S3DataSourceProperty
- type CfnModelPackage_S3ModelDataSourceProperty
- type CfnModelPackage_SecurityConfigProperty
- type CfnModelPackage_SourceAlgorithmProperty
- type CfnModelPackage_SourceAlgorithmSpecificationProperty
- type CfnModelPackage_TransformInputProperty
- type CfnModelPackage_TransformJobDefinitionProperty
- type CfnModelPackage_TransformOutputProperty
- type CfnModelPackage_TransformResourcesProperty
- type CfnModelPackage_ValidationProfileProperty
- type CfnModelPackage_ValidationSpecificationProperty
- type CfnModelProps
- type CfnModelQualityJobDefinition
- type CfnModelQualityJobDefinitionProps
- type CfnModelQualityJobDefinition_BatchTransformInputProperty
- type CfnModelQualityJobDefinition_ClusterConfigProperty
- type CfnModelQualityJobDefinition_ConstraintsResourceProperty
- type CfnModelQualityJobDefinition_CsvProperty
- type CfnModelQualityJobDefinition_DatasetFormatProperty
- type CfnModelQualityJobDefinition_EndpointInputProperty
- type CfnModelQualityJobDefinition_JsonProperty
- type CfnModelQualityJobDefinition_ModelQualityAppSpecificationProperty
- type CfnModelQualityJobDefinition_ModelQualityBaselineConfigProperty
- type CfnModelQualityJobDefinition_ModelQualityJobInputProperty
- type CfnModelQualityJobDefinition_MonitoringGroundTruthS3InputProperty
- type CfnModelQualityJobDefinition_MonitoringOutputConfigProperty
- type CfnModelQualityJobDefinition_MonitoringOutputProperty
- type CfnModelQualityJobDefinition_MonitoringResourcesProperty
- type CfnModelQualityJobDefinition_NetworkConfigProperty
- type CfnModelQualityJobDefinition_S3OutputProperty
- type CfnModelQualityJobDefinition_StoppingConditionProperty
- type CfnModelQualityJobDefinition_VpcConfigProperty
- type CfnModel_ContainerDefinitionProperty
- type CfnModel_HubAccessConfigProperty
- type CfnModel_ImageConfigProperty
- type CfnModel_InferenceExecutionConfigProperty
- type CfnModel_ModelAccessConfigProperty
- type CfnModel_ModelDataSourceProperty
- type CfnModel_MultiModelConfigProperty
- type CfnModel_RepositoryAuthConfigProperty
- type CfnModel_S3DataSourceProperty
- type CfnModel_VpcConfigProperty
- type CfnMonitoringSchedule
- type CfnMonitoringScheduleProps
- type CfnMonitoringSchedule_BaselineConfigProperty
- type CfnMonitoringSchedule_BatchTransformInputProperty
- type CfnMonitoringSchedule_ClusterConfigProperty
- type CfnMonitoringSchedule_ConstraintsResourceProperty
- type CfnMonitoringSchedule_CsvProperty
- type CfnMonitoringSchedule_DatasetFormatProperty
- type CfnMonitoringSchedule_EndpointInputProperty
- type CfnMonitoringSchedule_JsonProperty
- type CfnMonitoringSchedule_MonitoringAppSpecificationProperty
- type CfnMonitoringSchedule_MonitoringExecutionSummaryProperty
- type CfnMonitoringSchedule_MonitoringInputProperty
- type CfnMonitoringSchedule_MonitoringJobDefinitionProperty
- type CfnMonitoringSchedule_MonitoringOutputConfigProperty
- type CfnMonitoringSchedule_MonitoringOutputProperty
- type CfnMonitoringSchedule_MonitoringResourcesProperty
- type CfnMonitoringSchedule_MonitoringScheduleConfigProperty
- type CfnMonitoringSchedule_NetworkConfigProperty
- type CfnMonitoringSchedule_S3OutputProperty
- type CfnMonitoringSchedule_ScheduleConfigProperty
- type CfnMonitoringSchedule_StatisticsResourceProperty
- type CfnMonitoringSchedule_StoppingConditionProperty
- type CfnMonitoringSchedule_VpcConfigProperty
- type CfnNotebookInstance
- type CfnNotebookInstanceLifecycleConfig
- type CfnNotebookInstanceLifecycleConfigProps
- type CfnNotebookInstanceLifecycleConfig_NotebookInstanceLifecycleHookProperty
- type CfnNotebookInstanceProps
- type CfnNotebookInstance_InstanceMetadataServiceConfigurationProperty
- type CfnPipeline
- type CfnPipelineProps
- type CfnPipeline_ParallelismConfigurationProperty
- type CfnPipeline_PipelineDefinitionProperty
- type CfnPipeline_S3LocationProperty
- type CfnProject
- type CfnProjectProps
- type CfnProject_ProvisioningParameterProperty
- type CfnProject_ServiceCatalogProvisionedProductDetailsProperty
- type CfnProject_ServiceCatalogProvisioningDetailsProperty
- type CfnSpace
- type CfnSpaceProps
- type CfnSpace_CodeRepositoryProperty
- type CfnSpace_CustomFileSystemProperty
- type CfnSpace_CustomImageProperty
- type CfnSpace_EFSFileSystemProperty
- type CfnSpace_EbsStorageSettingsProperty
- type CfnSpace_JupyterServerAppSettingsProperty
- type CfnSpace_KernelGatewayAppSettingsProperty
- type CfnSpace_OwnershipSettingsProperty
- type CfnSpace_ResourceSpecProperty
- type CfnSpace_SpaceCodeEditorAppSettingsProperty
- type CfnSpace_SpaceJupyterLabAppSettingsProperty
- type CfnSpace_SpaceSettingsProperty
- type CfnSpace_SpaceSharingSettingsProperty
- type CfnSpace_SpaceStorageSettingsProperty
- type CfnStudioLifecycleConfig
- type CfnStudioLifecycleConfigProps
- type CfnUserProfile
- type CfnUserProfileProps
- type CfnUserProfile_CodeEditorAppSettingsProperty
- type CfnUserProfile_CodeRepositoryProperty
- type CfnUserProfile_CustomFileSystemConfigProperty
- type CfnUserProfile_CustomImageProperty
- type CfnUserProfile_CustomPosixUserConfigProperty
- type CfnUserProfile_DefaultEbsStorageSettingsProperty
- type CfnUserProfile_DefaultSpaceStorageSettingsProperty
- type CfnUserProfile_EFSFileSystemConfigProperty
- type CfnUserProfile_JupyterLabAppSettingsProperty
- type CfnUserProfile_JupyterServerAppSettingsProperty
- type CfnUserProfile_KernelGatewayAppSettingsProperty
- type CfnUserProfile_RStudioServerProAppSettingsProperty
- type CfnUserProfile_ResourceSpecProperty
- type CfnUserProfile_SharingSettingsProperty
- type CfnUserProfile_StudioWebPortalSettingsProperty
- type CfnUserProfile_UserSettingsProperty
- type CfnWorkteam
- type CfnWorkteamProps
- type CfnWorkteam_CognitoMemberDefinitionProperty
- type CfnWorkteam_MemberDefinitionProperty
- type CfnWorkteam_NotificationConfigurationProperty
- type CfnWorkteam_OidcMemberDefinitionProperty
- type IEndpoint
- type IPipeline
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAppImageConfig_IsConstruct ¶
func CfnAppImageConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApp_IsConstruct ¶
func CfnApp_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCluster_CFN_RESOURCE_TYPE_NAME ¶ added in v2.157.0
func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCluster_IsCfnElement ¶ added in v2.157.0
func CfnCluster_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 CfnCluster_IsCfnResource ¶ added in v2.157.0
func CfnCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCluster_IsConstruct ¶ added in v2.157.0
func CfnCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCodeRepository_IsConstruct ¶
func CfnCodeRepository_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataQualityJobDefinition_IsConstruct ¶
func CfnDataQualityJobDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDeviceFleet_IsConstruct ¶
func CfnDeviceFleet_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDevice_IsConstruct ¶
func CfnDevice_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDomain_IsConstruct ¶
func CfnDomain_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEndpointConfig_IsConstruct ¶
func CfnEndpointConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEndpoint_IsConstruct ¶
func CfnEndpoint_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFeatureGroup_IsConstruct ¶
func CfnFeatureGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnImageVersion_IsConstruct ¶
func CfnImageVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnImage_IsConstruct ¶
func CfnImage_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnInferenceComponent_CFN_RESOURCE_TYPE_NAME ¶ added in v2.113.0
func CfnInferenceComponent_CFN_RESOURCE_TYPE_NAME() *string
func CfnInferenceComponent_IsCfnElement ¶ added in v2.113.0
func CfnInferenceComponent_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 CfnInferenceComponent_IsCfnResource ¶ added in v2.113.0
func CfnInferenceComponent_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInferenceComponent_IsConstruct ¶ added in v2.113.0
func CfnInferenceComponent_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnInferenceExperiment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.70.0
func CfnInferenceExperiment_CFN_RESOURCE_TYPE_NAME() *string
func CfnInferenceExperiment_IsCfnElement ¶ added in v2.70.0
func CfnInferenceExperiment_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 CfnInferenceExperiment_IsCfnResource ¶ added in v2.70.0
func CfnInferenceExperiment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInferenceExperiment_IsConstruct ¶ added in v2.70.0
func CfnInferenceExperiment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMlflowTrackingServer_CFN_RESOURCE_TYPE_NAME ¶ added in v2.154.0
func CfnMlflowTrackingServer_CFN_RESOURCE_TYPE_NAME() *string
func CfnMlflowTrackingServer_IsCfnElement ¶ added in v2.154.0
func CfnMlflowTrackingServer_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 CfnMlflowTrackingServer_IsCfnResource ¶ added in v2.154.0
func CfnMlflowTrackingServer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMlflowTrackingServer_IsConstruct ¶ added in v2.154.0
func CfnMlflowTrackingServer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModelBiasJobDefinition_IsConstruct ¶
func CfnModelBiasJobDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnModelCard_CFN_RESOURCE_TYPE_NAME ¶ added in v2.64.0
func CfnModelCard_CFN_RESOURCE_TYPE_NAME() *string
func CfnModelCard_IsCfnElement ¶ added in v2.64.0
func CfnModelCard_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 CfnModelCard_IsCfnResource ¶ added in v2.64.0
func CfnModelCard_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModelCard_IsConstruct ¶ added in v2.64.0
func CfnModelCard_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModelExplainabilityJobDefinition_IsConstruct ¶
func CfnModelExplainabilityJobDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModelPackageGroup_IsConstruct ¶
func CfnModelPackageGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnModelPackage_CFN_RESOURCE_TYPE_NAME ¶ added in v2.45.0
func CfnModelPackage_CFN_RESOURCE_TYPE_NAME() *string
func CfnModelPackage_IsCfnElement ¶ added in v2.45.0
func CfnModelPackage_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 CfnModelPackage_IsCfnResource ¶ added in v2.45.0
func CfnModelPackage_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModelPackage_IsConstruct ¶ added in v2.45.0
func CfnModelPackage_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModelQualityJobDefinition_IsConstruct ¶
func CfnModelQualityJobDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModel_IsConstruct ¶
func CfnModel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMonitoringSchedule_IsConstruct ¶
func CfnMonitoringSchedule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNotebookInstanceLifecycleConfig_IsConstruct ¶
func CfnNotebookInstanceLifecycleConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNotebookInstance_IsConstruct ¶
func CfnNotebookInstance_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPipeline_IsConstruct ¶
func CfnPipeline_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProject_IsConstruct ¶
func CfnProject_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSpace_CFN_RESOURCE_TYPE_NAME ¶ added in v2.70.0
func CfnSpace_CFN_RESOURCE_TYPE_NAME() *string
func CfnSpace_IsCfnElement ¶ added in v2.70.0
func CfnSpace_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 CfnSpace_IsCfnResource ¶ added in v2.70.0
func CfnSpace_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSpace_IsConstruct ¶ added in v2.70.0
func CfnSpace_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStudioLifecycleConfig_CFN_RESOURCE_TYPE_NAME ¶ added in v2.154.0
func CfnStudioLifecycleConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnStudioLifecycleConfig_IsCfnElement ¶ added in v2.154.0
func CfnStudioLifecycleConfig_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 CfnStudioLifecycleConfig_IsCfnResource ¶ added in v2.154.0
func CfnStudioLifecycleConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStudioLifecycleConfig_IsConstruct ¶ added in v2.154.0
func CfnStudioLifecycleConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUserProfile_IsConstruct ¶
func CfnUserProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWorkteam_IsConstruct ¶
func CfnWorkteam_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnAppImageConfig_Override ¶
func NewCfnAppImageConfig_Override(c CfnAppImageConfig, scope constructs.Construct, id *string, props *CfnAppImageConfigProps)
func NewCfnApp_Override ¶
func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
func NewCfnCluster_Override ¶ added in v2.157.0
func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
func NewCfnCodeRepository_Override ¶
func NewCfnCodeRepository_Override(c CfnCodeRepository, scope constructs.Construct, id *string, props *CfnCodeRepositoryProps)
func NewCfnDataQualityJobDefinition_Override ¶
func NewCfnDataQualityJobDefinition_Override(c CfnDataQualityJobDefinition, scope constructs.Construct, id *string, props *CfnDataQualityJobDefinitionProps)
func NewCfnDeviceFleet_Override ¶
func NewCfnDeviceFleet_Override(c CfnDeviceFleet, scope constructs.Construct, id *string, props *CfnDeviceFleetProps)
func NewCfnDevice_Override ¶
func NewCfnDevice_Override(c CfnDevice, scope constructs.Construct, id *string, props *CfnDeviceProps)
func NewCfnDomain_Override ¶
func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
func NewCfnEndpointConfig_Override ¶
func NewCfnEndpointConfig_Override(c CfnEndpointConfig, scope constructs.Construct, id *string, props *CfnEndpointConfigProps)
func NewCfnEndpoint_Override ¶
func NewCfnEndpoint_Override(c CfnEndpoint, scope constructs.Construct, id *string, props *CfnEndpointProps)
func NewCfnFeatureGroup_Override ¶
func NewCfnFeatureGroup_Override(c CfnFeatureGroup, scope constructs.Construct, id *string, props *CfnFeatureGroupProps)
func NewCfnImageVersion_Override ¶
func NewCfnImageVersion_Override(c CfnImageVersion, scope constructs.Construct, id *string, props *CfnImageVersionProps)
func NewCfnImage_Override ¶
func NewCfnImage_Override(c CfnImage, scope constructs.Construct, id *string, props *CfnImageProps)
func NewCfnInferenceComponent_Override ¶ added in v2.113.0
func NewCfnInferenceComponent_Override(c CfnInferenceComponent, scope constructs.Construct, id *string, props *CfnInferenceComponentProps)
func NewCfnInferenceExperiment_Override ¶ added in v2.70.0
func NewCfnInferenceExperiment_Override(c CfnInferenceExperiment, scope constructs.Construct, id *string, props *CfnInferenceExperimentProps)
func NewCfnMlflowTrackingServer_Override ¶ added in v2.154.0
func NewCfnMlflowTrackingServer_Override(c CfnMlflowTrackingServer, scope constructs.Construct, id *string, props *CfnMlflowTrackingServerProps)
func NewCfnModelBiasJobDefinition_Override ¶
func NewCfnModelBiasJobDefinition_Override(c CfnModelBiasJobDefinition, scope constructs.Construct, id *string, props *CfnModelBiasJobDefinitionProps)
func NewCfnModelCard_Override ¶ added in v2.64.0
func NewCfnModelCard_Override(c CfnModelCard, scope constructs.Construct, id *string, props *CfnModelCardProps)
func NewCfnModelExplainabilityJobDefinition_Override ¶
func NewCfnModelExplainabilityJobDefinition_Override(c CfnModelExplainabilityJobDefinition, scope constructs.Construct, id *string, props *CfnModelExplainabilityJobDefinitionProps)
func NewCfnModelPackageGroup_Override ¶
func NewCfnModelPackageGroup_Override(c CfnModelPackageGroup, scope constructs.Construct, id *string, props *CfnModelPackageGroupProps)
func NewCfnModelPackage_Override ¶ added in v2.45.0
func NewCfnModelPackage_Override(c CfnModelPackage, scope constructs.Construct, id *string, props *CfnModelPackageProps)
func NewCfnModelQualityJobDefinition_Override ¶
func NewCfnModelQualityJobDefinition_Override(c CfnModelQualityJobDefinition, scope constructs.Construct, id *string, props *CfnModelQualityJobDefinitionProps)
func NewCfnModel_Override ¶
func NewCfnModel_Override(c CfnModel, scope constructs.Construct, id *string, props *CfnModelProps)
func NewCfnMonitoringSchedule_Override ¶
func NewCfnMonitoringSchedule_Override(c CfnMonitoringSchedule, scope constructs.Construct, id *string, props *CfnMonitoringScheduleProps)
func NewCfnNotebookInstanceLifecycleConfig_Override ¶
func NewCfnNotebookInstanceLifecycleConfig_Override(c CfnNotebookInstanceLifecycleConfig, scope constructs.Construct, id *string, props *CfnNotebookInstanceLifecycleConfigProps)
func NewCfnNotebookInstance_Override ¶
func NewCfnNotebookInstance_Override(c CfnNotebookInstance, scope constructs.Construct, id *string, props *CfnNotebookInstanceProps)
func NewCfnPipeline_Override ¶
func NewCfnPipeline_Override(c CfnPipeline, scope constructs.Construct, id *string, props *CfnPipelineProps)
func NewCfnProject_Override ¶
func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
func NewCfnSpace_Override ¶ added in v2.70.0
func NewCfnSpace_Override(c CfnSpace, scope constructs.Construct, id *string, props *CfnSpaceProps)
func NewCfnStudioLifecycleConfig_Override ¶ added in v2.154.0
func NewCfnStudioLifecycleConfig_Override(c CfnStudioLifecycleConfig, scope constructs.Construct, id *string, props *CfnStudioLifecycleConfigProps)
func NewCfnUserProfile_Override ¶
func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, props *CfnUserProfileProps)
func NewCfnWorkteam_Override ¶
func NewCfnWorkteam_Override(c CfnWorkteam, scope constructs.Construct, id *string, props *CfnWorkteamProps)
Types ¶
type CfnApp ¶
type CfnApp interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The name of the app. AppName() *string SetAppName(val *string) // The type of app. AppType() *string SetAppType(val *string) // The Amazon Resource Name (ARN) of the app, such as `arn:aws:sagemaker:us-west-2:account-id:app/my-app-name` . AttrAppArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The domain ID. DomainId() *string SetDomainId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. ResourceSpec() interface{} SetResourceSpec(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The user profile name. UserProfileName() *string SetUserProfileName(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a running app for the specified UserProfile.
This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApp := awscdk.Aws_sagemaker.NewCfnApp(this, jsii.String("MyCfnApp"), &CfnAppProps{ AppName: jsii.String("appName"), AppType: jsii.String("appType"), DomainId: jsii.String("domainId"), UserProfileName: jsii.String("userProfileName"), // the properties below are optional ResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html
func NewCfnApp ¶
func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp
type CfnAppImageConfig ¶
type CfnAppImageConfig interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The name of the AppImageConfig. AppImageConfigName() *string SetAppImageConfigName(val *string) // The Amazon Resource Name (ARN) of the AppImageConfig, such as `arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name` . AttrAppImageConfigArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The configuration for the file system and the runtime, such as the environment variables and entry point. CodeEditorAppImageConfig() interface{} SetCodeEditorAppImageConfig(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The configuration for the file system and the runtime, such as the environment variables and entry point. JupyterLabAppImageConfig() interface{} SetJupyterLabAppImageConfig(val interface{}) // The configuration for the file system and kernels in the SageMaker image. KernelGatewayImageConfig() interface{} SetKernelGatewayImageConfig(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a configuration for running a SageMaker image as a KernelGateway app.
The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAppImageConfig := awscdk.Aws_sagemaker.NewCfnAppImageConfig(this, jsii.String("MyCfnAppImageConfig"), &CfnAppImageConfigProps{ AppImageConfigName: jsii.String("appImageConfigName"), // the properties below are optional CodeEditorAppImageConfig: &CodeEditorAppImageConfigProperty{ ContainerConfig: &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, }, JupyterLabAppImageConfig: &JupyterLabAppImageConfigProperty{ ContainerConfig: &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, }, KernelGatewayImageConfig: &KernelGatewayImageConfigProperty{ KernelSpecs: []interface{}{ &KernelSpecProperty{ Name: jsii.String("name"), // the properties below are optional DisplayName: jsii.String("displayName"), }, }, // the properties below are optional FileSystemConfig: &FileSystemConfigProperty{ DefaultGid: jsii.Number(123), DefaultUid: jsii.Number(123), MountPath: jsii.String("mountPath"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnAppImageConfig ¶
func NewCfnAppImageConfig(scope constructs.Construct, id *string, props *CfnAppImageConfigProps) CfnAppImageConfig
type CfnAppImageConfigProps ¶
type CfnAppImageConfigProps struct { // The name of the AppImageConfig. // // Must be unique to your account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-appimageconfigname // AppImageConfigName *string `field:"required" json:"appImageConfigName" yaml:"appImageConfigName"` // The configuration for the file system and the runtime, such as the environment variables and entry point. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-codeeditorappimageconfig // CodeEditorAppImageConfig interface{} `field:"optional" json:"codeEditorAppImageConfig" yaml:"codeEditorAppImageConfig"` // The configuration for the file system and the runtime, such as the environment variables and entry point. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-jupyterlabappimageconfig // JupyterLabAppImageConfig interface{} `field:"optional" json:"jupyterLabAppImageConfig" yaml:"jupyterLabAppImageConfig"` // The configuration for the file system and kernels in the SageMaker image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig // KernelGatewayImageConfig interface{} `field:"optional" json:"kernelGatewayImageConfig" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAppImageConfig`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAppImageConfigProps := &CfnAppImageConfigProps{ AppImageConfigName: jsii.String("appImageConfigName"), // the properties below are optional CodeEditorAppImageConfig: &CodeEditorAppImageConfigProperty{ ContainerConfig: &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, }, JupyterLabAppImageConfig: &JupyterLabAppImageConfigProperty{ ContainerConfig: &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, }, KernelGatewayImageConfig: &KernelGatewayImageConfigProperty{ KernelSpecs: []interface{}{ &KernelSpecProperty{ Name: jsii.String("name"), // the properties below are optional DisplayName: jsii.String("displayName"), }, }, // the properties below are optional FileSystemConfig: &FileSystemConfigProperty{ DefaultGid: jsii.Number(123), DefaultUid: jsii.Number(123), MountPath: jsii.String("mountPath"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnAppImageConfig_CodeEditorAppImageConfigProperty ¶ added in v2.138.0
type CfnAppImageConfig_CodeEditorAppImageConfigProperty struct { // The container configuration for a SageMaker image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-codeeditorappimageconfig.html#cfn-sagemaker-appimageconfig-codeeditorappimageconfig-containerconfig // ContainerConfig interface{} `field:"optional" json:"containerConfig" yaml:"containerConfig"` }
The configuration for the file system and kernels in a SageMaker image running as a Code Editor app.
The `FileSystemConfig` object is not supported.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" codeEditorAppImageConfigProperty := &CodeEditorAppImageConfigProperty{ ContainerConfig: &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, }
type CfnAppImageConfig_ContainerConfigProperty ¶ added in v2.127.0
type CfnAppImageConfig_ContainerConfigProperty struct { // The arguments for the container when you're running the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerarguments // ContainerArguments *[]*string `field:"optional" json:"containerArguments" yaml:"containerArguments"` // The entrypoint used to run the application in the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerentrypoint // ContainerEntrypoint *[]*string `field:"optional" json:"containerEntrypoint" yaml:"containerEntrypoint"` // The environment variables to set in the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerenvironmentvariables // ContainerEnvironmentVariables interface{} `field:"optional" json:"containerEnvironmentVariables" yaml:"containerEnvironmentVariables"` }
The configuration used to run the application image container.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" containerConfigProperty := &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnAppImageConfig_CustomImageContainerEnvironmentVariableProperty ¶ added in v2.127.0
type CfnAppImageConfig_CustomImageContainerEnvironmentVariableProperty struct { // The key that identifies a container environment variable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html#cfn-sagemaker-appimageconfig-customimagecontainerenvironmentvariable-key // Key *string `field:"required" json:"key" yaml:"key"` // The value of the container environment variable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html#cfn-sagemaker-appimageconfig-customimagecontainerenvironmentvariable-value // Value *string `field:"required" json:"value" yaml:"value"` }
The environment variables to set in the container.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customImageContainerEnvironmentVariableProperty := &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }
type CfnAppImageConfig_FileSystemConfigProperty ¶
type CfnAppImageConfig_FileSystemConfigProperty struct { // The default POSIX group ID (GID). // // If not specified, defaults to `100` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-defaultgid // DefaultGid *float64 `field:"optional" json:"defaultGid" yaml:"defaultGid"` // The default POSIX user ID (UID). // // If not specified, defaults to `1000` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-defaultuid // DefaultUid *float64 `field:"optional" json:"defaultUid" yaml:"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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-mountpath // MountPath *string `field:"optional" json:"mountPath" yaml:"mountPath"` }
The Amazon Elastic File System storage configuration for a SageMaker image.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fileSystemConfigProperty := &FileSystemConfigProperty{ DefaultGid: jsii.Number(123), DefaultUid: jsii.Number(123), MountPath: jsii.String("mountPath"), }
type CfnAppImageConfig_JupyterLabAppImageConfigProperty ¶ added in v2.127.0
type CfnAppImageConfig_JupyterLabAppImageConfigProperty struct { // The configuration used to run the application image container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html#cfn-sagemaker-appimageconfig-jupyterlabappimageconfig-containerconfig // ContainerConfig interface{} `field:"optional" json:"containerConfig" yaml:"containerConfig"` }
The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app.
The `FileSystemConfig` object is not supported.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jupyterLabAppImageConfigProperty := &JupyterLabAppImageConfigProperty{ ContainerConfig: &ContainerConfigProperty{ ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, ContainerEnvironmentVariables: []interface{}{ &CustomImageContainerEnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }, }
type CfnAppImageConfig_KernelGatewayImageConfigProperty ¶
type CfnAppImageConfig_KernelGatewayImageConfigProperty struct { // The specification of the Jupyter kernels in the image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-kernelspecs // KernelSpecs interface{} `field:"required" json:"kernelSpecs" yaml:"kernelSpecs"` // The Amazon Elastic File System storage configuration for a SageMaker image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-filesystemconfig // FileSystemConfig interface{} `field:"optional" json:"fileSystemConfig" yaml:"fileSystemConfig"` }
The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kernelGatewayImageConfigProperty := &KernelGatewayImageConfigProperty{ KernelSpecs: []interface{}{ &KernelSpecProperty{ Name: jsii.String("name"), // the properties below are optional DisplayName: jsii.String("displayName"), }, }, // the properties below are optional FileSystemConfig: &FileSystemConfigProperty{ DefaultGid: jsii.Number(123), DefaultUid: jsii.Number(123), MountPath: jsii.String("mountPath"), }, }
type CfnAppImageConfig_KernelSpecProperty ¶
type CfnAppImageConfig_KernelSpecProperty struct { // The name of the Jupyter kernel in the image. // // This value is case sensitive. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html#cfn-sagemaker-appimageconfig-kernelspec-name // Name *string `field:"required" json:"name" yaml:"name"` // The display name of the kernel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html#cfn-sagemaker-appimageconfig-kernelspec-displayname // DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"` }
The specification of a Jupyter kernel.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kernelSpecProperty := &KernelSpecProperty{ Name: jsii.String("name"), // the properties below are optional DisplayName: jsii.String("displayName"), }
type CfnAppProps ¶
type CfnAppProps struct { // The name of the app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-appname // AppName *string `field:"required" json:"appName" yaml:"appName"` // The type of app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-apptype // AppType *string `field:"required" json:"appType" yaml:"appType"` // The domain ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-domainid // DomainId *string `field:"required" json:"domainId" yaml:"domainId"` // The user profile name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-userprofilename // UserProfileName *string `field:"required" json:"userProfileName" yaml:"userProfileName"` // Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-resourcespec // ResourceSpec interface{} `field:"optional" json:"resourceSpec" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnApp`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAppProps := &CfnAppProps{ AppName: jsii.String("appName"), AppType: jsii.String("appType"), DomainId: jsii.String("domainId"), UserProfileName: jsii.String("userProfileName"), // the properties below are optional ResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html
type CfnApp_ResourceSpecProperty ¶
type CfnApp_ResourceSpecProperty struct { // The instance type that the image version runs on. // // > *JupyterServer apps* only support the `system` value. // > // > For *KernelGateway apps* , the `system` value is translated to `ml.t3.medium` . KernelGateway apps also support all other values for available instance types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-instancetype // InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"` // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-lifecycleconfigarn // LifecycleConfigArn *string `field:"optional" json:"lifecycleConfigArn" yaml:"lifecycleConfigArn"` // The ARN of the SageMaker image that the image version belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimagearn // SageMakerImageArn *string `field:"optional" json:"sageMakerImageArn" yaml:"sageMakerImageArn"` // The ARN of the image version created on the instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimageversionarn // SageMakerImageVersionArn *string `field:"optional" json:"sageMakerImageVersionArn" yaml:"sageMakerImageVersionArn"` }
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" resourceSpecProperty := &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }
type CfnCluster ¶ added in v2.157.0
type CfnCluster interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the HyperPod Cluster. AttrClusterArn() *string // The status of the HyperPod Cluster. AttrClusterStatus() *string // The time at which the HyperPod cluster was created. AttrCreationTime() *string // The failure message of the HyperPod Cluster. AttrFailureMessage() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the HyperPod Cluster. ClusterName() *string SetClusterName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The instance groups of the SageMaker HyperPod cluster. InstanceGroups() interface{} SetInstanceGroups(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. NodeRecovery() *string SetNodeRecovery(val *string) // Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster. Orchestrator() interface{} SetOrchestrator(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. VpcConfig() interface{} SetVpcConfig(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Resource Type definition for AWS::SageMaker::Cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCluster := awscdk.Aws_sagemaker.NewCfnCluster(this, jsii.String("MyCfnCluster"), &CfnClusterProps{ InstanceGroups: []interface{}{ &ClusterInstanceGroupProperty{ ExecutionRole: jsii.String("executionRole"), InstanceCount: jsii.Number(123), InstanceGroupName: jsii.String("instanceGroupName"), InstanceType: jsii.String("instanceType"), LifeCycleConfig: &ClusterLifeCycleConfigProperty{ OnCreate: jsii.String("onCreate"), SourceS3Uri: jsii.String("sourceS3Uri"), }, // the properties below are optional CurrentCount: jsii.Number(123), InstanceStorageConfigs: []interface{}{ &ClusterInstanceStorageConfigProperty{ EbsVolumeConfig: &ClusterEbsVolumeConfigProperty{ VolumeSizeInGb: jsii.Number(123), }, }, }, OnStartDeepHealthChecks: []*string{ jsii.String("onStartDeepHealthChecks"), }, ThreadsPerCore: jsii.Number(123), }, }, // the properties below are optional ClusterName: jsii.String("clusterName"), NodeRecovery: jsii.String("nodeRecovery"), Orchestrator: &OrchestratorProperty{ Eks: &ClusterOrchestratorEksConfigProperty{ ClusterArn: jsii.String("clusterArn"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html
func NewCfnCluster ¶ added in v2.157.0
func NewCfnCluster(scope constructs.Construct, id *string, props *CfnClusterProps) CfnCluster
type CfnClusterProps ¶ added in v2.157.0
type CfnClusterProps struct { // The instance groups of the SageMaker HyperPod cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups // InstanceGroups interface{} `field:"required" json:"instanceGroups" yaml:"instanceGroups"` // The name of the HyperPod Cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clustername // ClusterName *string `field:"optional" json:"clusterName" yaml:"clusterName"` // If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. // // If set to false, nodes will be labelled when a fault is detected. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery // NodeRecovery *string `field:"optional" json:"nodeRecovery" yaml:"nodeRecovery"` // Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator // Orchestrator interface{} `field:"optional" json:"orchestrator" yaml:"orchestrator"` // Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. // // You can add tags to your cluster in the same way you add them in other AWS services that support tagging. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. // // You can control access to and from your resources by configuring a VPC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"` }
Properties for defining a `CfnCluster`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnClusterProps := &CfnClusterProps{ InstanceGroups: []interface{}{ &ClusterInstanceGroupProperty{ ExecutionRole: jsii.String("executionRole"), InstanceCount: jsii.Number(123), InstanceGroupName: jsii.String("instanceGroupName"), InstanceType: jsii.String("instanceType"), LifeCycleConfig: &ClusterLifeCycleConfigProperty{ OnCreate: jsii.String("onCreate"), SourceS3Uri: jsii.String("sourceS3Uri"), }, // the properties below are optional CurrentCount: jsii.Number(123), InstanceStorageConfigs: []interface{}{ &ClusterInstanceStorageConfigProperty{ EbsVolumeConfig: &ClusterEbsVolumeConfigProperty{ VolumeSizeInGb: jsii.Number(123), }, }, }, OnStartDeepHealthChecks: []*string{ jsii.String("onStartDeepHealthChecks"), }, ThreadsPerCore: jsii.Number(123), }, }, // the properties below are optional ClusterName: jsii.String("clusterName"), NodeRecovery: jsii.String("nodeRecovery"), Orchestrator: &OrchestratorProperty{ Eks: &ClusterOrchestratorEksConfigProperty{ ClusterArn: jsii.String("clusterArn"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html
type CfnCluster_ClusterEbsVolumeConfigProperty ¶ added in v2.157.0
type CfnCluster_ClusterEbsVolumeConfigProperty struct { // The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. // // The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumesizeingb // VolumeSizeInGb *float64 `field:"optional" json:"volumeSizeInGb" yaml:"volumeSizeInGb"` }
Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group.
The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterEbsVolumeConfigProperty := &ClusterEbsVolumeConfigProperty{ VolumeSizeInGb: jsii.Number(123), }
type CfnCluster_ClusterInstanceGroupProperty ¶ added in v2.157.0
type CfnCluster_ClusterInstanceGroupProperty struct { // The execution role for the instance group to assume. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-executionrole // ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"` // The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The name of the instance group of a SageMaker HyperPod cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname // InstanceGroupName *string `field:"required" json:"instanceGroupName" yaml:"instanceGroupName"` // The instance type of the instance group of a SageMaker HyperPod cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The lifecycle configuration for a SageMaker HyperPod cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig // LifeCycleConfig interface{} `field:"required" json:"lifeCycleConfig" yaml:"lifeCycleConfig"` // The number of instances that are currently in the instance group of a SageMaker HyperPod cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-currentcount // CurrentCount *float64 `field:"optional" json:"currentCount" yaml:"currentCount"` // The instance storage configuration for the instance group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs // InstanceStorageConfigs interface{} `field:"optional" json:"instanceStorageConfigs" yaml:"instanceStorageConfigs"` // Nodes will undergo advanced stress test to detect and replace faulty instances, based on the type of deep health check(s) passed in. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks // OnStartDeepHealthChecks *[]*string `field:"optional" json:"onStartDeepHealthChecks" yaml:"onStartDeepHealthChecks"` // The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. // // For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore // ThreadsPerCore *float64 `field:"optional" json:"threadsPerCore" yaml:"threadsPerCore"` }
Details of an instance group in a SageMaker HyperPod cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterInstanceGroupProperty := &ClusterInstanceGroupProperty{ ExecutionRole: jsii.String("executionRole"), InstanceCount: jsii.Number(123), InstanceGroupName: jsii.String("instanceGroupName"), InstanceType: jsii.String("instanceType"), LifeCycleConfig: &ClusterLifeCycleConfigProperty{ OnCreate: jsii.String("onCreate"), SourceS3Uri: jsii.String("sourceS3Uri"), }, // the properties below are optional CurrentCount: jsii.Number(123), InstanceStorageConfigs: []interface{}{ &ClusterInstanceStorageConfigProperty{ EbsVolumeConfig: &ClusterEbsVolumeConfigProperty{ VolumeSizeInGb: jsii.Number(123), }, }, }, OnStartDeepHealthChecks: []*string{ jsii.String("onStartDeepHealthChecks"), }, ThreadsPerCore: jsii.Number(123), }
type CfnCluster_ClusterInstanceStorageConfigProperty ¶ added in v2.157.0
type CfnCluster_ClusterInstanceStorageConfigProperty struct { // Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. // // The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html#cfn-sagemaker-cluster-clusterinstancestorageconfig-ebsvolumeconfig // EbsVolumeConfig interface{} `field:"optional" json:"ebsVolumeConfig" yaml:"ebsVolumeConfig"` }
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterInstanceStorageConfigProperty := &ClusterInstanceStorageConfigProperty{ EbsVolumeConfig: &ClusterEbsVolumeConfigProperty{ VolumeSizeInGb: jsii.Number(123), }, }
type CfnCluster_ClusterLifeCycleConfigProperty ¶ added in v2.157.0
type CfnCluster_ClusterLifeCycleConfigProperty struct { // The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. // // This entrypoint script runs during cluster creation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html#cfn-sagemaker-cluster-clusterlifecycleconfig-oncreate // OnCreate *string `field:"required" json:"onCreate" yaml:"onCreate"` // An Amazon S3 bucket path where your lifecycle scripts are stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html#cfn-sagemaker-cluster-clusterlifecycleconfig-sources3uri // SourceS3Uri *string `field:"required" json:"sourceS3Uri" yaml:"sourceS3Uri"` }
The lifecycle configuration for a SageMaker HyperPod cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterLifeCycleConfigProperty := &ClusterLifeCycleConfigProperty{ OnCreate: jsii.String("onCreate"), SourceS3Uri: jsii.String("sourceS3Uri"), }
type CfnCluster_ClusterOrchestratorEksConfigProperty ¶ added in v2.157.0
type CfnCluster_ClusterOrchestratorEksConfigProperty struct { // The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.html#cfn-sagemaker-cluster-clusterorchestratoreksconfig-clusterarn // ClusterArn *string `field:"required" json:"clusterArn" yaml:"clusterArn"` }
Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterOrchestratorEksConfigProperty := &ClusterOrchestratorEksConfigProperty{ ClusterArn: jsii.String("clusterArn"), }
type CfnCluster_OrchestratorProperty ¶ added in v2.157.0
type CfnCluster_OrchestratorProperty struct { // Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-orchestrator.html#cfn-sagemaker-cluster-orchestrator-eks // Eks interface{} `field:"required" json:"eks" yaml:"eks"` }
Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" orchestratorProperty := &OrchestratorProperty{ Eks: &ClusterOrchestratorEksConfigProperty{ ClusterArn: jsii.String("clusterArn"), }, }
type CfnCluster_VpcConfigProperty ¶ added in v2.157.0
type CfnCluster_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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html#cfn-sagemaker-cluster-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"` // The ID of the subnets in the VPC to which you want to connect your training job or model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-vpcconfig.html#cfn-sagemaker-cluster-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
type CfnCodeRepository ¶
type CfnCodeRepository interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The name of the code repository, such as `myCodeRepo` . AttrCodeRepositoryName() *string AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The name of the Git repository. CodeRepositoryName() *string SetCodeRepositoryName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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{} SetGitConfig(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // List of tags for Code Repository. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a Git repository as a resource in your 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 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCodeRepository := awscdk.Aws_sagemaker.NewCfnCodeRepository(this, jsii.String("MyCfnCodeRepository"), &CfnCodeRepositoryProps{ GitConfig: &GitConfigProperty{ RepositoryUrl: jsii.String("repositoryUrl"), // the properties below are optional Branch: jsii.String("branch"), SecretArn: jsii.String("secretArn"), }, // the properties below are optional CodeRepositoryName: jsii.String("codeRepositoryName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnCodeRepository ¶
func NewCfnCodeRepository(scope constructs.Construct, id *string, props *CfnCodeRepositoryProps) CfnCodeRepository
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-gitconfig // GitConfig interface{} `field:"required" json:"gitConfig" yaml:"gitConfig"` // The name of the Git repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-coderepositoryname // CodeRepositoryName *string `field:"optional" json:"codeRepositoryName" yaml:"codeRepositoryName"` // List of tags for Code Repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCodeRepository`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCodeRepositoryProps := &CfnCodeRepositoryProps{ GitConfig: &GitConfigProperty{ RepositoryUrl: jsii.String("repositoryUrl"), // the properties below are optional Branch: jsii.String("branch"), SecretArn: jsii.String("secretArn"), }, // the properties below are optional CodeRepositoryName: jsii.String("codeRepositoryName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnCodeRepository_GitConfigProperty ¶
type CfnCodeRepository_GitConfigProperty struct { // The URL where the Git repository is located. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-repositoryurl // RepositoryUrl *string `field:"required" json:"repositoryUrl" yaml:"repositoryUrl"` // The default branch for the Git repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-branch // Branch *string `field:"optional" json:"branch" yaml:"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* }`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html#cfn-sagemaker-coderepository-gitconfig-secretarn // SecretArn *string `field:"optional" json:"secretArn" yaml:"secretArn"` }
Specifies configuration details for a Git repository in your AWS account.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" gitConfigProperty := &GitConfigProperty{ RepositoryUrl: jsii.String("repositoryUrl"), // the properties below are optional Branch: jsii.String("branch"), SecretArn: jsii.String("secretArn"), }
type CfnDataQualityJobDefinition ¶
type CfnDataQualityJobDefinition interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time when the job definition was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the job definition. AttrJobDefinitionArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies the container that runs the monitoring job. DataQualityAppSpecification() interface{} SetDataQualityAppSpecification(val interface{}) // Configures the constraints and baselines for the monitoring job. DataQualityBaselineConfig() interface{} SetDataQualityBaselineConfig(val interface{}) // A list of inputs for the monitoring job. DataQualityJobInput() interface{} SetDataQualityJobInput(val interface{}) // The output configuration for monitoring jobs. DataQualityJobOutputConfig() interface{} SetDataQualityJobOutputConfig(val interface{}) // The name of the endpoint used to run the monitoring job. EndpointName() *string SetEndpointName(val *string) // The name for the monitoring job definition. JobDefinitionName() *string SetJobDefinitionName(val *string) // Identifies the resources to deploy for a monitoring job. JobResources() interface{} SetJobResources(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Specifies networking configuration for the monitoring job. NetworkConfig() interface{} SetNetworkConfig(val interface{}) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A time limit for how long the monitoring job is allowed to run before stopping. StoppingCondition() interface{} SetStoppingCondition(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataQualityJobDefinition := awscdk.Aws_sagemaker.NewCfnDataQualityJobDefinition(this, jsii.String("MyCfnDataQualityJobDefinition"), &CfnDataQualityJobDefinitionProps{ DataQualityAppSpecification: &DataQualityAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, DataQualityJobInput: &DataQualityJobInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, DataQualityJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional DataQualityBaselineConfig: &DataQualityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnDataQualityJobDefinition ¶
func NewCfnDataQualityJobDefinition(scope constructs.Construct, id *string, props *CfnDataQualityJobDefinitionProps) CfnDataQualityJobDefinition
type CfnDataQualityJobDefinitionProps ¶
type CfnDataQualityJobDefinitionProps struct { // Specifies the container that runs the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification // DataQualityAppSpecification interface{} `field:"required" json:"dataQualityAppSpecification" yaml:"dataQualityAppSpecification"` // A list of inputs for the monitoring job. // // Currently endpoints are supported as monitoring inputs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput // DataQualityJobInput interface{} `field:"required" json:"dataQualityJobInput" yaml:"dataQualityJobInput"` // The output configuration for monitoring jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjoboutputconfig // DataQualityJobOutputConfig interface{} `field:"required" json:"dataQualityJobOutputConfig" yaml:"dataQualityJobOutputConfig"` // Identifies the resources to deploy for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-jobresources // JobResources interface{} `field:"required" json:"jobResources" yaml:"jobResources"` // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // Configures the constraints and baselines for the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig // DataQualityBaselineConfig interface{} `field:"optional" json:"dataQualityBaselineConfig" yaml:"dataQualityBaselineConfig"` // The name of the endpoint used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // The name for the monitoring job definition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-jobdefinitionname // JobDefinitionName *string `field:"optional" json:"jobDefinitionName" yaml:"jobDefinitionName"` // Specifies networking configuration for the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig // NetworkConfig interface{} `field:"optional" json:"networkConfig" yaml:"networkConfig"` // A time limit for how long the monitoring job is allowed to run before stopping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-stoppingcondition // StoppingCondition interface{} `field:"optional" json:"stoppingCondition" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDataQualityJobDefinition`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataQualityJobDefinitionProps := &CfnDataQualityJobDefinitionProps{ DataQualityAppSpecification: &DataQualityAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, DataQualityJobInput: &DataQualityJobInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, DataQualityJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional DataQualityBaselineConfig: &DataQualityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnDataQualityJobDefinition_BatchTransformInputProperty ¶ added in v2.48.0
type CfnDataQualityJobDefinition_BatchTransformInputProperty struct { // The Amazon S3 location being used to capture the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-datacaptureddestinations3uri // DataCapturedDestinationS3Uri *string `field:"required" json:"dataCapturedDestinationS3Uri" yaml:"dataCapturedDestinationS3Uri"` // The dataset format for your batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-datasetformat // DatasetFormat interface{} `field:"required" json:"datasetFormat" yaml:"datasetFormat"` // Path to the filesystem where the batch transform data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // The attributes of the input data to exclude from the analysis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-excludefeaturesattribute // ExcludeFeaturesAttribute *string `field:"optional" json:"excludeFeaturesAttribute" yaml:"excludeFeaturesAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-dataqualityjobdefinition-batchtransforminput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"s3InputMode"` }
Input object for the batch transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" batchTransformInputProperty := &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The ML compute instance type for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The size of the ML storage volume, in gigabytes, that you want to provision. // // You must specify sufficient ML storage for your scenario. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-volumesizeingb // VolumeSizeInGb *float64 `field:"required" json:"volumeSizeInGb" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-clusterconfig.html#cfn-sagemaker-dataqualityjobdefinition-clusterconfig-volumekmskeyid // VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"` }
The configuration for the cluster of resources used to run the processing job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterConfigProperty := &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }
type CfnDataQualityJobDefinition_ConstraintsResourceProperty ¶
type CfnDataQualityJobDefinition_ConstraintsResourceProperty struct { // The Amazon S3 URI for the constraints resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-constraintsresource.html#cfn-sagemaker-dataqualityjobdefinition-constraintsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
The constraints resource for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" constraintsResourceProperty := &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnDataQualityJobDefinition_CsvProperty ¶ added in v2.48.0
type CfnDataQualityJobDefinition_CsvProperty struct { // A boolean flag indicating if given CSV has header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html#cfn-sagemaker-dataqualityjobdefinition-csv-header // Header interface{} `field:"optional" json:"header" yaml:"header"` }
The CSV format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvProperty := &CsvProperty{ Header: jsii.Boolean(false), }
type CfnDataQualityJobDefinition_DataQualityAppSpecificationProperty ¶
type CfnDataQualityJobDefinition_DataQualityAppSpecificationProperty struct { // The container image that the data quality monitoring job runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-imageuri // ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"` // The arguments to send to the container that the monitoring job runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-containerarguments // ContainerArguments *[]*string `field:"optional" json:"containerArguments" yaml:"containerArguments"` // The entrypoint for a container used to run a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-containerentrypoint // ContainerEntrypoint *[]*string `field:"optional" json:"containerEntrypoint" yaml:"containerEntrypoint"` // Sets the environment variables in the container that the monitoring job runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-environment // Environment interface{} `field:"optional" json:"environment" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-postanalyticsprocessorsourceuri // PostAnalyticsProcessorSourceUri *string `field:"optional" json:"postAnalyticsProcessorSourceUri" yaml:"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 flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityappspecification.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification-recordpreprocessorsourceuri // RecordPreprocessorSourceUri *string `field:"optional" json:"recordPreprocessorSourceUri" yaml:"recordPreprocessorSourceUri"` }
Information about the container that a data quality monitoring job runs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataQualityAppSpecificationProperty := &DataQualityAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }
type CfnDataQualityJobDefinition_DataQualityBaselineConfigProperty ¶
type CfnDataQualityJobDefinition_DataQualityBaselineConfigProperty struct { // The name of the job that performs baselining for the data quality monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig-baseliningjobname // BaseliningJobName *string `field:"optional" json:"baseliningJobName" yaml:"baseliningJobName"` // The constraints resource for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig-constraintsresource // ConstraintsResource interface{} `field:"optional" json:"constraintsResource" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig-statisticsresource // StatisticsResource interface{} `field:"optional" json:"statisticsResource" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataQualityBaselineConfigProperty := &DataQualityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }
type CfnDataQualityJobDefinition_DataQualityJobInputProperty ¶
type CfnDataQualityJobDefinition_DataQualityJobInputProperty struct { // Input object for the batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput-batchtransforminput // BatchTransformInput interface{} `field:"optional" json:"batchTransformInput" yaml:"batchTransformInput"` // Input object for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput-endpointinput // EndpointInput interface{} `field:"optional" json:"endpointInput" yaml:"endpointInput"` }
The input for the data quality monitoring job.
Currently endpoints are supported for input.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataQualityJobInputProperty := &DataQualityJobInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }
type CfnDataQualityJobDefinition_DatasetFormatProperty ¶ added in v2.48.0
type CfnDataQualityJobDefinition_DatasetFormatProperty struct { // The CSV format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-csv // Csv interface{} `field:"optional" json:"csv" yaml:"csv"` // The Json format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-json // Json interface{} `field:"optional" json:"json" yaml:"json"` // A flag indicate if the dataset format is Parquet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-parquet // Parquet interface{} `field:"optional" json:"parquet" yaml:"parquet"` }
The dataset format of the data to monitor.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetFormatProperty := &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }
type CfnDataQualityJobDefinition_EndpointInputProperty ¶
type CfnDataQualityJobDefinition_EndpointInputProperty struct { // An endpoint in customer's account which has enabled `DataCaptureConfig` enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // Path to the filesystem where the endpoint data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // The attributes of the input data to exclude from the analysis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-excludefeaturesattribute // ExcludeFeaturesAttribute *string `field:"optional" json:"excludeFeaturesAttribute" yaml:"excludeFeaturesAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html#cfn-sagemaker-dataqualityjobdefinition-endpointinput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"s3InputMode"` }
Input object for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointInputProperty := &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }
type CfnDataQualityJobDefinition_JsonProperty ¶ added in v2.48.0
type CfnDataQualityJobDefinition_JsonProperty struct { // A boolean flag indicating if it is JSON line format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html#cfn-sagemaker-dataqualityjobdefinition-json-line // Line interface{} `field:"optional" json:"line" yaml:"line"` }
The Json format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jsonProperty := &JsonProperty{ Line: jsii.Boolean(false), }
type CfnDataQualityJobDefinition_MonitoringOutputConfigProperty ¶
type CfnDataQualityJobDefinition_MonitoringOutputConfigProperty struct { // Monitoring outputs for monitoring jobs. // // This is where the output of the periodic monitoring jobs is uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-dataqualityjobdefinition-monitoringoutputconfig-monitoringoutputs // MonitoringOutputs interface{} `field:"required" json:"monitoringOutputs" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-dataqualityjobdefinition-monitoringoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The output configuration for monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputConfigProperty := &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnDataQualityJobDefinition_MonitoringOutputProperty ¶
type CfnDataQualityJobDefinition_MonitoringOutputProperty struct { // The Amazon S3 storage location where the results of a monitoring job are saved. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutput.html#cfn-sagemaker-dataqualityjobdefinition-monitoringoutput-s3output // S3Output interface{} `field:"required" json:"s3Output" yaml:"s3Output"` }
The output object for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputProperty := &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }
type CfnDataQualityJobDefinition_MonitoringResourcesProperty ¶
type CfnDataQualityJobDefinition_MonitoringResourcesProperty struct { // The configuration for the cluster resources used to run the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringresources.html#cfn-sagemaker-dataqualityjobdefinition-monitoringresources-clusterconfig // ClusterConfig interface{} `field:"required" json:"clusterConfig" yaml:"clusterConfig"` }
Identifies the resources to deploy for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringResourcesProperty := &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig-enableintercontainertrafficencryption // EnableInterContainerTrafficEncryption interface{} `field:"optional" json:"enableInterContainerTrafficEncryption" yaml:"enableInterContainerTrafficEncryption"` // Whether to allow inbound and outbound network calls to and from the containers used for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" networkConfigProperty := &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html#cfn-sagemaker-dataqualityjobdefinition-s3output-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html#cfn-sagemaker-dataqualityjobdefinition-s3output-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // Whether to upload the results of the monitoring job continuously or after the job completes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html#cfn-sagemaker-dataqualityjobdefinition-s3output-s3uploadmode // S3UploadMode *string `field:"optional" json:"s3UploadMode" yaml:"s3UploadMode"` }
The Amazon S3 storage location where the results of a monitoring job are saved.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3OutputProperty := &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }
type CfnDataQualityJobDefinition_StatisticsResourceProperty ¶
type CfnDataQualityJobDefinition_StatisticsResourceProperty struct { // The Amazon S3 URI for the statistics resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-statisticsresource.html#cfn-sagemaker-dataqualityjobdefinition-statisticsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
The statistics resource for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statisticsResourceProperty := &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnDataQualityJobDefinition_StoppingConditionProperty ¶
type CfnDataQualityJobDefinition_StoppingConditionProperty struct { // The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. // // For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model. // // For all other jobs, if the job does not complete during this time, 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. // // The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-stoppingcondition.html#cfn-sagemaker-dataqualityjobdefinition-stoppingcondition-maxruntimeinseconds // MaxRuntimeInSeconds *float64 `field:"required" json:"maxRuntimeInSeconds" yaml:"maxRuntimeInSeconds"` }
Specifies a limit to how long a job can run.
When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, 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 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stoppingConditionProperty := &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-vpcconfig.html#cfn-sagemaker-dataqualityjobdefinition-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-vpcconfig.html#cfn-sagemaker-dataqualityjobdefinition-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
type CfnDevice ¶
type CfnDevice interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Edge device you want to create. Device() interface{} SetDevice(val interface{}) // The name of the fleet the device belongs to. DeviceFleetName() *string SetDeviceFleetName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs that contain metadata to help you categorize and organize your devices. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDevice := awscdk.Aws_sagemaker.NewCfnDevice(this, jsii.String("MyCfnDevice"), &CfnDeviceProps{ DeviceFleetName: jsii.String("deviceFleetName"), // the properties below are optional Device: &DeviceProperty{ DeviceName: jsii.String("deviceName"), // the properties below are optional Description: jsii.String("description"), IotThingName: jsii.String("iotThingName"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html
func NewCfnDevice ¶
func NewCfnDevice(scope constructs.Construct, id *string, props *CfnDeviceProps) CfnDevice
type CfnDeviceFleet ¶
type CfnDeviceFleet interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the fleet. Description() *string SetDescription(val *string) // Name of the device fleet. DeviceFleetName() *string SetDeviceFleetName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The output configuration for storing sample data collected by the fleet. OutputConfig() interface{} SetOutputConfig(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT). RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs that contain metadata to help you categorize and organize your device fleets. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDeviceFleet := awscdk.Aws_sagemaker.NewCfnDeviceFleet(this, jsii.String("MyCfnDeviceFleet"), &CfnDeviceFleetProps{ DeviceFleetName: jsii.String("deviceFleetName"), OutputConfig: &EdgeOutputConfigProperty{ S3OutputLocation: jsii.String("s3OutputLocation"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnDeviceFleet ¶
func NewCfnDeviceFleet(scope constructs.Construct, id *string, props *CfnDeviceFleetProps) CfnDeviceFleet
type CfnDeviceFleetProps ¶
type CfnDeviceFleetProps struct { // Name of the device fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-devicefleetname // DeviceFleetName *string `field:"required" json:"deviceFleetName" yaml:"deviceFleetName"` // The output configuration for storing sample data collected by the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-outputconfig // OutputConfig interface{} `field:"required" json:"outputConfig" yaml:"outputConfig"` // The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // A description of the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-description // Description *string `field:"optional" json:"description" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDeviceFleet`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDeviceFleetProps := &CfnDeviceFleetProps{ DeviceFleetName: jsii.String("deviceFleetName"), OutputConfig: &EdgeOutputConfigProperty{ S3OutputLocation: jsii.String("s3OutputLocation"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnDeviceFleet_EdgeOutputConfigProperty ¶
type CfnDeviceFleet_EdgeOutputConfigProperty struct { // The Amazon Simple Storage (S3) bucket URI. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-devicefleet-edgeoutputconfig.html#cfn-sagemaker-devicefleet-edgeoutputconfig-s3outputlocation // S3OutputLocation *string `field:"required" json:"s3OutputLocation" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-devicefleet-edgeoutputconfig.html#cfn-sagemaker-devicefleet-edgeoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The output configuration for storing sample data collected by the fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" edgeOutputConfigProperty := &EdgeOutputConfigProperty{ S3OutputLocation: jsii.String("s3OutputLocation"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnDeviceProps ¶
type CfnDeviceProps struct { // The name of the fleet the device belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html#cfn-sagemaker-device-devicefleetname // DeviceFleetName *string `field:"required" json:"deviceFleetName" yaml:"deviceFleetName"` // Edge device you want to create. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html#cfn-sagemaker-device-device // Device interface{} `field:"optional" json:"device" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html#cfn-sagemaker-device-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDevice`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDeviceProps := &CfnDeviceProps{ DeviceFleetName: jsii.String("deviceFleetName"), // the properties below are optional Device: &DeviceProperty{ DeviceName: jsii.String("deviceName"), // the properties below are optional Description: jsii.String("description"), IotThingName: jsii.String("iotThingName"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-device.html
type CfnDevice_DeviceProperty ¶
type CfnDevice_DeviceProperty struct { // The name of the device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html#cfn-sagemaker-device-device-devicename // DeviceName *string `field:"required" json:"deviceName" yaml:"deviceName"` // Description of the device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html#cfn-sagemaker-device-device-description // Description *string `field:"optional" json:"description" yaml:"description"` // AWS Internet of Things (IoT) object name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html#cfn-sagemaker-device-device-iotthingname // IotThingName *string `field:"optional" json:"iotThingName" yaml:"iotThingName"` }
Information of a particular device.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deviceProperty := &DeviceProperty{ DeviceName: jsii.String("deviceName"), // the properties below are optional Description: jsii.String("description"), IotThingName: jsii.String("iotThingName"), }
type CfnDomain ¶
type CfnDomain interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Specifies the VPC used for non-EFS traffic. // // The default value is `PublicInternetOnly` . AppNetworkAccessType() *string SetAppNetworkAccessType(val *string) // The entity that creates and manages the required security groups for inter-app communication in `VpcOnly` mode. AppSecurityGroupManagement() *string SetAppSecurityGroupManagement(val *string) // The Amazon Resource Name (ARN) of the Domain, such as `arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name` . AttrDomainArn() *string // The Domain ID. AttrDomainId() *string // The ID of the Amazon Elastic File System (EFS) managed by this Domain. AttrHomeEfsFileSystemId() *string // The ID of the security group that authorizes traffic between the `RSessionGateway` apps and the `RStudioServerPro` app. AttrSecurityGroupIdForDomainBoundary() *string // The ARN of the application managed by SageMaker in IAM Identity Center. // // This value is only returned for domains created after October 1, 2023. AttrSingleSignOnApplicationArn() *string // The IAM Identity Center managed application instance ID. AttrSingleSignOnManagedApplicationInstanceId() *string // The URL for the Domain. AttrUrl() *string // The mode of authentication that members use to access the Domain. AuthMode() *string SetAuthMode(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A collection of settings that apply to spaces created in the domain. DefaultSpaceSettings() interface{} SetDefaultSpaceSettings(val interface{}) // The default user settings. DefaultUserSettings() interface{} SetDefaultUserSettings(val interface{}) // The domain name. DomainName() *string SetDomainName(val *string) // A collection of settings that apply to the `SageMaker Domain` . DomainSettings() interface{} SetDomainSettings(val interface{}) // SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. KmsKeyId() *string SetKmsKeyId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The VPC subnets that Studio uses for communication. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags to associated with the Domain. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. VpcId() *string SetVpcId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a `Domain` .
A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. 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 traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the `AppNetworkAccessType` parameter. `AppNetworkAccessType` corresponds to the network access type that you choose when you onboard to the domain. 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 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 Amazon SageMaker 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 Amazon SageMaker Studio app successfully.
For more information, see [Connect Amazon SageMaker Studio Notebooks to Resources in a VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDomain := awscdk.Aws_sagemaker.NewCfnDomain(this, jsii.String("MyCfnDomain"), &CfnDomainProps{ AuthMode: jsii.String("authMode"), DefaultUserSettings: &UserSettingsProperty{ ExecutionRole: jsii.String("executionRole"), // the properties below are optional CodeEditorAppSettings: &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, DefaultLandingUri: jsii.String("defaultLandingUri"), JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, RSessionAppSettings: &RSessionAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SharingSettings: &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, StudioWebPortal: jsii.String("studioWebPortal"), StudioWebPortalSettings: &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }, }, DomainName: jsii.String("domainName"), SubnetIds: []*string{ jsii.String("subnetIds"), }, VpcId: jsii.String("vpcId"), // the properties below are optional AppNetworkAccessType: jsii.String("appNetworkAccessType"), AppSecurityGroupManagement: jsii.String("appSecurityGroupManagement"), DefaultSpaceSettings: &DefaultSpaceSettingsProperty{ ExecutionRole: jsii.String("executionRole"), // the properties below are optional CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, }, DomainSettings: &DomainSettingsProperty{ DockerSettings: &DockerSettingsProperty{ EnableDockerAccess: jsii.String("enableDockerAccess"), VpcOnlyTrustedAccounts: []*string{ jsii.String("vpcOnlyTrustedAccounts"), }, }, RStudioServerProDomainSettings: &RStudioServerProDomainSettingsProperty{ DomainExecutionRoleArn: jsii.String("domainExecutionRoleArn"), // the properties below are optional DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, RStudioConnectUrl: jsii.String("rStudioConnectUrl"), RStudioPackageManagerUrl: jsii.String("rStudioPackageManagerUrl"), }, SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, }, KmsKeyId: jsii.String("kmsKeyId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html
func NewCfnDomain ¶
func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain
type CfnDomainProps ¶
type CfnDomainProps struct { // The mode of authentication that members use to access the Domain. // // *Valid Values* : `SSO | IAM`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-authmode // AuthMode *string `field:"required" json:"authMode" yaml:"authMode"` // The default user settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultusersettings // DefaultUserSettings interface{} `field:"required" json:"defaultUserSettings" yaml:"defaultUserSettings"` // The domain name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainname // DomainName *string `field:"required" json:"domainName" yaml:"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]+`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-subnetids // SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"` // The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. // // *Length Constraints* : Maximum length of 32. // // *Pattern* : `[-0-9a-zA-Z]+`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-vpcid // VpcId *string `field:"required" json:"vpcId" yaml:"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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appnetworkaccesstype // AppNetworkAccessType *string `field:"optional" json:"appNetworkAccessType" yaml:"appNetworkAccessType"` // The entity that creates and manages the required security groups for inter-app communication in `VpcOnly` mode. // // Required when `CreateDomain.AppNetworkAccessType` is `VpcOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided. If setting up the domain for use with RStudio, this value must be set to `Service` . // // *Allowed Values* : `Service` | `Customer`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appsecuritygroupmanagement // AppSecurityGroupManagement *string `field:"optional" json:"appSecurityGroupManagement" yaml:"appSecurityGroupManagement"` // A collection of settings that apply to spaces created in the domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultspacesettings // DefaultSpaceSettings interface{} `field:"optional" json:"defaultSpaceSettings" yaml:"defaultSpaceSettings"` // A collection of settings that apply to the `SageMaker Domain` . // // These settings are specified through the `CreateDomain` API call. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainsettings // DomainSettings interface{} `field:"optional" json:"domainSettings" yaml:"domainSettings"` // 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* : `.*` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDomain`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDomainProps := &CfnDomainProps{ AuthMode: jsii.String("authMode"), DefaultUserSettings: &UserSettingsProperty{ ExecutionRole: jsii.String("executionRole"), // the properties below are optional CodeEditorAppSettings: &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, DefaultLandingUri: jsii.String("defaultLandingUri"), JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, RSessionAppSettings: &RSessionAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SharingSettings: &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, StudioWebPortal: jsii.String("studioWebPortal"), StudioWebPortalSettings: &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }, }, DomainName: jsii.String("domainName"), SubnetIds: []*string{ jsii.String("subnetIds"), }, VpcId: jsii.String("vpcId"), // the properties below are optional AppNetworkAccessType: jsii.String("appNetworkAccessType"), AppSecurityGroupManagement: jsii.String("appSecurityGroupManagement"), DefaultSpaceSettings: &DefaultSpaceSettingsProperty{ ExecutionRole: jsii.String("executionRole"), // the properties below are optional CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, }, DomainSettings: &DomainSettingsProperty{ DockerSettings: &DockerSettingsProperty{ EnableDockerAccess: jsii.String("enableDockerAccess"), VpcOnlyTrustedAccounts: []*string{ jsii.String("vpcOnlyTrustedAccounts"), }, }, RStudioServerProDomainSettings: &RStudioServerProDomainSettingsProperty{ DomainExecutionRoleArn: jsii.String("domainExecutionRoleArn"), // the properties below are optional DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, RStudioConnectUrl: jsii.String("rStudioConnectUrl"), RStudioPackageManagerUrl: jsii.String("rStudioPackageManagerUrl"), }, SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, }, KmsKeyId: jsii.String("kmsKeyId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html
type CfnDomain_CodeEditorAppSettingsProperty ¶ added in v2.110.0
type CfnDomain_CodeEditorAppSettingsProperty struct { // A list of custom SageMaker images that are configured to run as a Code Editor app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the Code Editor app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The Code Editor application settings.
For more information about Code Editor, see [Get started with Code Editor in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" codeEditorAppSettingsProperty := &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnDomain_CodeRepositoryProperty ¶ added in v2.110.0
type CfnDomain_CodeRepositoryProperty struct { // The URL of the Git repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-coderepository.html#cfn-sagemaker-domain-coderepository-repositoryurl // RepositoryUrl *string `field:"required" json:"repositoryUrl" yaml:"repositoryUrl"` }
A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" codeRepositoryProperty := &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }
type CfnDomain_CustomFileSystemConfigProperty ¶ added in v2.110.0
type CfnDomain_CustomFileSystemConfigProperty struct { // The settings for a custom Amazon EFS file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-efsfilesystemconfig // EfsFileSystemConfig interface{} `field:"optional" json:"efsFileSystemConfig" yaml:"efsFileSystemConfig"` }
The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain.
Permitted users can access this file system in Amazon SageMaker Studio.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customFileSystemConfigProperty := &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }
type CfnDomain_CustomImageProperty ¶
type CfnDomain_CustomImageProperty struct { // The name of the AppImageConfig. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html#cfn-sagemaker-domain-customimage-appimageconfigname // AppImageConfigName *string `field:"required" json:"appImageConfigName" yaml:"appImageConfigName"` // The name of the CustomImage. // // Must be unique to your account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html#cfn-sagemaker-domain-customimage-imagename // ImageName *string `field:"required" json:"imageName" yaml:"imageName"` // The version number of the CustomImage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html#cfn-sagemaker-domain-customimage-imageversionnumber // ImageVersionNumber *float64 `field:"optional" json:"imageVersionNumber" yaml:"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) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customImageProperty := &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }
type CfnDomain_CustomPosixUserConfigProperty ¶ added in v2.110.0
type CfnDomain_CustomPosixUserConfigProperty struct { // The POSIX group ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html#cfn-sagemaker-domain-customposixuserconfig-gid // Gid *float64 `field:"required" json:"gid" yaml:"gid"` // The POSIX user ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html#cfn-sagemaker-domain-customposixuserconfig-uid // Uid *float64 `field:"required" json:"uid" yaml:"uid"` }
Details about the POSIX identity that is used for file system operations.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customPosixUserConfigProperty := &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }
type CfnDomain_DefaultEbsStorageSettingsProperty ¶ added in v2.110.0
type CfnDomain_DefaultEbsStorageSettingsProperty struct { // The default size of the EBS storage volume for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html#cfn-sagemaker-domain-defaultebsstoragesettings-defaultebsvolumesizeingb // DefaultEbsVolumeSizeInGb *float64 `field:"required" json:"defaultEbsVolumeSizeInGb" yaml:"defaultEbsVolumeSizeInGb"` // The maximum size of the EBS storage volume for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html#cfn-sagemaker-domain-defaultebsstoragesettings-maximumebsvolumesizeingb // MaximumEbsVolumeSizeInGb *float64 `field:"required" json:"maximumEbsVolumeSizeInGb" yaml:"maximumEbsVolumeSizeInGb"` }
A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultEbsStorageSettingsProperty := &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }
type CfnDomain_DefaultSpaceSettingsProperty ¶ added in v2.63.0
type CfnDomain_DefaultSpaceSettingsProperty struct { // The ARN of the execution role for the space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-executionrole // ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"` // The settings for assigning a custom file system to a domain. // // Permitted users can access this file system in Amazon SageMaker Studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-customfilesystemconfigs // CustomFileSystemConfigs interface{} `field:"optional" json:"customFileSystemConfigs" yaml:"customFileSystemConfigs"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-customposixuserconfig // CustomPosixUserConfig interface{} `field:"optional" json:"customPosixUserConfig" yaml:"customPosixUserConfig"` // The JupyterLab app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-jupyterlabappsettings // JupyterLabAppSettings interface{} `field:"optional" json:"jupyterLabAppSettings" yaml:"jupyterLabAppSettings"` // The JupyterServer app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-jupyterserverappsettings // JupyterServerAppSettings interface{} `field:"optional" json:"jupyterServerAppSettings" yaml:"jupyterServerAppSettings"` // The KernelGateway app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-kernelgatewayappsettings // KernelGatewayAppSettings interface{} `field:"optional" json:"kernelGatewayAppSettings" yaml:"kernelGatewayAppSettings"` // The security group IDs for the Amazon VPC that the space uses for communication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-securitygroups // SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"` // Default storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-spacestoragesettings // SpaceStorageSettings interface{} `field:"optional" json:"spaceStorageSettings" yaml:"spaceStorageSettings"` }
A collection of settings that apply to spaces created in the domain.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultSpaceSettingsProperty := &DefaultSpaceSettingsProperty{ ExecutionRole: jsii.String("executionRole"), // the properties below are optional CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, }
type CfnDomain_DefaultSpaceStorageSettingsProperty ¶ added in v2.110.0
type CfnDomain_DefaultSpaceStorageSettingsProperty struct { // The default EBS storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacestoragesettings.html#cfn-sagemaker-domain-defaultspacestoragesettings-defaultebsstoragesettings // DefaultEbsStorageSettings interface{} `field:"optional" json:"defaultEbsStorageSettings" yaml:"defaultEbsStorageSettings"` }
The default storage settings for a space.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultSpaceStorageSettingsProperty := &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }
type CfnDomain_DockerSettingsProperty ¶ added in v2.127.0
type CfnDomain_DockerSettingsProperty struct { // Indicates whether the domain can access Docker. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html#cfn-sagemaker-domain-dockersettings-enabledockeraccess // EnableDockerAccess *string `field:"optional" json:"enableDockerAccess" yaml:"enableDockerAccess"` // The list of AWS accounts that are trusted when the domain is created in VPC-only mode. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html#cfn-sagemaker-domain-dockersettings-vpconlytrustedaccounts // VpcOnlyTrustedAccounts *[]*string `field:"optional" json:"vpcOnlyTrustedAccounts" yaml:"vpcOnlyTrustedAccounts"` }
A collection of settings that configure the domain's Docker interaction.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dockerSettingsProperty := &DockerSettingsProperty{ EnableDockerAccess: jsii.String("enableDockerAccess"), VpcOnlyTrustedAccounts: []*string{ jsii.String("vpcOnlyTrustedAccounts"), }, }
type CfnDomain_DomainSettingsProperty ¶ added in v2.20.0
type CfnDomain_DomainSettingsProperty struct { // A collection of settings that configure the domain's Docker interaction. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-dockersettings // DockerSettings interface{} `field:"optional" json:"dockerSettings" yaml:"dockerSettings"` // A collection of settings that configure the `RStudioServerPro` Domain-level app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-rstudioserverprodomainsettings // RStudioServerProDomainSettings interface{} `field:"optional" json:"rStudioServerProDomainSettings" yaml:"rStudioServerProDomainSettings"` // The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-securitygroupids // SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"` }
A collection of settings that apply to the `SageMaker Domain` .
These settings are specified through the `CreateDomain` API call.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" domainSettingsProperty := &DomainSettingsProperty{ DockerSettings: &DockerSettingsProperty{ EnableDockerAccess: jsii.String("enableDockerAccess"), VpcOnlyTrustedAccounts: []*string{ jsii.String("vpcOnlyTrustedAccounts"), }, }, RStudioServerProDomainSettings: &RStudioServerProDomainSettingsProperty{ DomainExecutionRoleArn: jsii.String("domainExecutionRoleArn"), // the properties below are optional DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, RStudioConnectUrl: jsii.String("rStudioConnectUrl"), RStudioPackageManagerUrl: jsii.String("rStudioPackageManagerUrl"), }, SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, }
type CfnDomain_EFSFileSystemConfigProperty ¶ added in v2.110.0
type CfnDomain_EFSFileSystemConfigProperty struct { // The ID of your Amazon EFS file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.html#cfn-sagemaker-domain-efsfilesystemconfig-filesystemid // FileSystemId *string `field:"required" json:"fileSystemId" yaml:"fileSystemId"` // The path to the file system directory that is accessible in Amazon SageMaker Studio. // // Permitted users can access only this directory and below. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.html#cfn-sagemaker-domain-efsfilesystemconfig-filesystempath // FileSystemPath *string `field:"optional" json:"fileSystemPath" yaml:"fileSystemPath"` }
The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker Domain.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eFSFileSystemConfigProperty := &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }
type CfnDomain_JupyterLabAppSettingsProperty ¶ added in v2.110.0
type CfnDomain_JupyterLabAppSettingsProperty struct { // A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-coderepositories // CodeRepositories interface{} `field:"optional" json:"codeRepositories" yaml:"codeRepositories"` // A list of custom SageMaker images that are configured to run as a JupyterLab app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. // // To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The settings for the JupyterLab application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jupyterLabAppSettingsProperty := &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html#cfn-sagemaker-domain-jupyterserverappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. // // If you use this parameter, the `DefaultResourceSpec` parameter is also required. // // > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html#cfn-sagemaker-domain-jupyterserverappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The JupyterServer app settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jupyterServerAppSettingsProperty := &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnDomain_KernelGatewayAppSettingsProperty ¶
type CfnDomain_KernelGatewayAppSettingsProperty struct { // A list of custom SageMaker images that are configured to run as a KernelGateway app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. // // > The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or AWS CloudFormation and the instance type parameter value is not passed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain. // // > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The KernelGateway app settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kernelGatewayAppSettingsProperty := &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnDomain_RSessionAppSettingsProperty ¶ added in v2.45.0
type CfnDomain_RSessionAppSettingsProperty struct { // A list of custom SageMaker images that are configured to run as a RSession app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html#cfn-sagemaker-domain-rsessionappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html#cfn-sagemaker-domain-rsessionappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` }
A collection of settings that apply to an `RSessionGateway` app.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rSessionAppSettingsProperty := &RSessionAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }
type CfnDomain_RStudioServerProAppSettingsProperty ¶ added in v2.20.0
type CfnDomain_RStudioServerProAppSettingsProperty struct { // Indicates whether the current user has access to the `RStudioServerPro` app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html#cfn-sagemaker-domain-rstudioserverproappsettings-accessstatus // AccessStatus *string `field:"optional" json:"accessStatus" yaml:"accessStatus"` // The level of permissions that the user has within the `RStudioServerPro` app. // // This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html#cfn-sagemaker-domain-rstudioserverproappsettings-usergroup // UserGroup *string `field:"optional" json:"userGroup" yaml:"userGroup"` }
A collection of settings that configure user interaction with the `RStudioServerPro` app.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rStudioServerProAppSettingsProperty := &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }
type CfnDomain_RStudioServerProDomainSettingsProperty ¶ added in v2.20.0
type CfnDomain_RStudioServerProDomainSettingsProperty struct { // The ARN of the execution role for the `RStudioServerPro` Domain-level app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-domainexecutionrolearn // DomainExecutionRoleArn *string `field:"required" json:"domainExecutionRoleArn" yaml:"domainExecutionRoleArn"` // A collection that defines the default `InstanceType` , `SageMakerImageArn` , and `SageMakerImageVersionArn` for the Domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // A URL pointing to an RStudio Connect server. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-rstudioconnecturl // RStudioConnectUrl *string `field:"optional" json:"rStudioConnectUrl" yaml:"rStudioConnectUrl"` // A URL pointing to an RStudio Package Manager server. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-rstudiopackagemanagerurl // RStudioPackageManagerUrl *string `field:"optional" json:"rStudioPackageManagerUrl" yaml:"rStudioPackageManagerUrl"` }
A collection of settings that configure the `RStudioServerPro` Domain-level app.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rStudioServerProDomainSettingsProperty := &RStudioServerProDomainSettingsProperty{ DomainExecutionRoleArn: jsii.String("domainExecutionRoleArn"), // the properties below are optional DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, RStudioConnectUrl: jsii.String("rStudioConnectUrl"), RStudioPackageManagerUrl: jsii.String("rStudioPackageManagerUrl"), }
type CfnDomain_ResourceSpecProperty ¶
type CfnDomain_ResourceSpecProperty struct { // The instance type that the image version runs on. // // > *JupyterServer apps* only support the `system` value. // > // > For *KernelGateway apps* , the `system` value is translated to `ml.t3.medium` . KernelGateway apps also support all other values for available instance types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-instancetype // InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"` // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-lifecycleconfigarn // LifecycleConfigArn *string `field:"optional" json:"lifecycleConfigArn" yaml:"lifecycleConfigArn"` // The ARN of the SageMaker image that the image version belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-sagemakerimagearn // SageMakerImageArn *string `field:"optional" json:"sageMakerImageArn" yaml:"sageMakerImageArn"` // The ARN of the image version created on the instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-sagemakerimageversionarn // SageMakerImageVersionArn *string `field:"optional" json:"sageMakerImageVersionArn" yaml:"sageMakerImageVersionArn"` }
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" resourceSpecProperty := &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }
type CfnDomain_SharingSettingsProperty ¶
type CfnDomain_SharingSettingsProperty struct { // Whether to include the notebook cell output when sharing the notebook. // // The default is `Disabled` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-notebookoutputoption // NotebookOutputOption *string `field:"optional" json:"notebookOutputOption" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-s3kmskeyid // S3KmsKeyId *string `field:"optional" json:"s3KmsKeyId" yaml:"s3KmsKeyId"` // When `NotebookOutputOption` is `Allowed` , the Amazon S3 bucket used to store the shared notebook snapshots. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-s3outputpath // S3OutputPath *string `field:"optional" json:"s3OutputPath" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sharingSettingsProperty := &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }
type CfnDomain_StudioWebPortalSettingsProperty ¶ added in v2.154.0
type CfnDomain_StudioWebPortalSettingsProperty struct { // The [Applications supported in Studio](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html) that are hidden from the Studio left navigation pane. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddenapptypes // HiddenAppTypes *[]*string `field:"optional" json:"hiddenAppTypes" yaml:"hiddenAppTypes"` // The machine learning tools that are hidden from the Studio left navigation pane. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddenmltools // HiddenMlTools *[]*string `field:"optional" json:"hiddenMlTools" yaml:"hiddenMlTools"` }
Studio settings.
If these settings are applied on a user level, they take priority over the settings applied on a domain level.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" studioWebPortalSettingsProperty := &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }
type CfnDomain_UserSettingsProperty ¶
type CfnDomain_UserSettingsProperty struct { // The execution role for the user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-executionrole // ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"` // The Code Editor application settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-codeeditorappsettings // CodeEditorAppSettings interface{} `field:"optional" json:"codeEditorAppSettings" yaml:"codeEditorAppSettings"` // The settings for assigning a custom file system to a user profile. // // Permitted users can access this file system in Amazon SageMaker Studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customfilesystemconfigs // CustomFileSystemConfigs interface{} `field:"optional" json:"customFileSystemConfigs" yaml:"customFileSystemConfigs"` // Details about the POSIX identity that is used for file system operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customposixuserconfig // CustomPosixUserConfig interface{} `field:"optional" json:"customPosixUserConfig" yaml:"customPosixUserConfig"` // The default experience that the user is directed to when accessing the domain. The supported values are:. // // - `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` . // - `app:JupyterServer:` : Indicates that Studio Classic is the default experience. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-defaultlandinguri // DefaultLandingUri *string `field:"optional" json:"defaultLandingUri" yaml:"defaultLandingUri"` // The settings for the JupyterLab application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-jupyterlabappsettings // JupyterLabAppSettings interface{} `field:"optional" json:"jupyterLabAppSettings" yaml:"jupyterLabAppSettings"` // The Jupyter server's app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-jupyterserverappsettings // JupyterServerAppSettings interface{} `field:"optional" json:"jupyterServerAppSettings" yaml:"jupyterServerAppSettings"` // The kernel gateway app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-kernelgatewayappsettings // KernelGatewayAppSettings interface{} `field:"optional" json:"kernelGatewayAppSettings" yaml:"kernelGatewayAppSettings"` // A collection of settings that configure the `RSessionGateway` app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rsessionappsettings // RSessionAppSettings interface{} `field:"optional" json:"rSessionAppSettings" yaml:"rSessionAppSettings"` // A collection of settings that configure user interaction with the `RStudioServerPro` app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rstudioserverproappsettings // RStudioServerProAppSettings interface{} `field:"optional" json:"rStudioServerProAppSettings" yaml:"rStudioServerProAppSettings"` // The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. // // Optional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` . // // Required when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` , unless specified as part of the `DefaultUserSettings` for the domain. // // Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-securitygroups // SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"` // Specifies options for sharing Amazon SageMaker Studio notebooks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-sharingsettings // SharingSettings interface{} `field:"optional" json:"sharingSettings" yaml:"sharingSettings"` // The storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-spacestoragesettings // SpaceStorageSettings interface{} `field:"optional" json:"spaceStorageSettings" yaml:"spaceStorageSettings"` // Whether the user can access Studio. // // If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportal // StudioWebPortal *string `field:"optional" json:"studioWebPortal" yaml:"studioWebPortal"` // Studio settings. // // If these settings are applied on a user level, they take priority over the settings applied on a domain level. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportalsettings // StudioWebPortalSettings interface{} `field:"optional" json:"studioWebPortalSettings" yaml:"studioWebPortalSettings"` }
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` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" userSettingsProperty := &UserSettingsProperty{ ExecutionRole: jsii.String("executionRole"), // the properties below are optional CodeEditorAppSettings: &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, DefaultLandingUri: jsii.String("defaultLandingUri"), JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, RSessionAppSettings: &RSessionAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SharingSettings: &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, StudioWebPortal: jsii.String("studioWebPortal"), StudioWebPortalSettings: &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }, }
type CfnEndpoint ¶
type CfnEndpoint interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The name of the endpoint, such as `MyEndpoint` . AttrEndpointName() *string AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. DeploymentConfig() interface{} SetDeploymentConfig(val interface{}) // 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 SetEndpointConfigName(val *string) // 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 SetEndpointName(val *string) // 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{} SetExcludeRetainedVariantProperties(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. RetainAllVariantProperties() interface{} SetRetainAllVariantProperties(val interface{}) // Specifies whether to reuse the last deployment configuration. RetainDeploymentConfig() interface{} SetRetainDeploymentConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEndpoint := awscdk.Aws_sagemaker.NewCfnEndpoint(this, jsii.String("MyCfnEndpoint"), &CfnEndpointProps{ EndpointConfigName: jsii.String("endpointConfigName"), // the properties below are optional DeploymentConfig: &DeploymentConfigProperty{ AutoRollbackConfiguration: &AutoRollbackConfigProperty{ Alarms: []interface{}{ &AlarmProperty{ AlarmName: jsii.String("alarmName"), }, }, }, BlueGreenUpdatePolicy: &BlueGreenUpdatePolicyProperty{ TrafficRoutingConfiguration: &TrafficRoutingConfigProperty{ Type: jsii.String("type"), // the properties below are optional CanarySize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, LinearStepSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), }, // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), TerminationWaitInSeconds: jsii.Number(123), }, RollingUpdatePolicy: &RollingUpdatePolicyProperty{ MaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), RollbackMaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, }, }, EndpointName: jsii.String("endpointName"), ExcludeRetainedVariantProperties: []interface{}{ &VariantPropertyProperty{ VariantPropertyType: jsii.String("variantPropertyType"), }, }, RetainAllVariantProperties: jsii.Boolean(false), RetainDeploymentConfig: jsii.Boolean(false), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html
func NewCfnEndpoint ¶
func NewCfnEndpoint(scope constructs.Construct, id *string, props *CfnEndpointProps) CfnEndpoint
type CfnEndpointConfig ¶
type CfnEndpointConfig interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Specifies configuration for how an endpoint performs asynchronous inference. AsyncInferenceConfig() interface{} SetAsyncInferenceConfig(val interface{}) // The name of the endpoint configuration, such as `MyEndpointConfiguration` . AttrEndpointConfigName() *string AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies how to capture endpoint data for model monitor. DataCaptureConfig() interface{} SetDataCaptureConfig(val interface{}) EnableNetworkIsolation() interface{} SetEnableNetworkIsolation(val interface{}) // The name of the endpoint configuration. EndpointConfigName() *string SetEndpointConfigName(val *string) ExecutionRoleArn() *string SetExecutionRoleArn(val *string) // A parameter to activate explainers. ExplainerConfig() interface{} SetExplainerConfig(val interface{}) // 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. KmsKeyId() *string SetKmsKeyId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint. ProductionVariants() interface{} SetProductionVariants(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Array of `ProductionVariant` objects. ShadowProductionVariants() interface{} SetShadowProductionVariants(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} VpcConfig() interface{} SetVpcConfig(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEndpointConfig := awscdk.Aws_sagemaker.NewCfnEndpointConfig(this, jsii.String("MyCfnEndpointConfig"), &CfnEndpointConfigProps{ ProductionVariants: []interface{}{ &ProductionVariantProperty{ VariantName: jsii.String("variantName"), // the properties below are optional AcceleratorType: jsii.String("acceleratorType"), ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), EnableSsmAccess: jsii.Boolean(false), InitialInstanceCount: jsii.Number(123), InitialVariantWeight: jsii.Number(123), InstanceType: jsii.String("instanceType"), ManagedInstanceScaling: &ManagedInstanceScalingProperty{ MaxInstanceCount: jsii.Number(123), MinInstanceCount: jsii.Number(123), Status: jsii.String("status"), }, ModelDataDownloadTimeoutInSeconds: jsii.Number(123), ModelName: jsii.String("modelName"), RoutingConfig: &RoutingConfigProperty{ RoutingStrategy: jsii.String("routingStrategy"), }, ServerlessConfig: &ServerlessConfigProperty{ MaxConcurrency: jsii.Number(123), MemorySizeInMb: jsii.Number(123), // the properties below are optional ProvisionedConcurrency: jsii.Number(123), }, VolumeSizeInGb: jsii.Number(123), }, }, // the properties below are optional AsyncInferenceConfig: &AsyncInferenceConfigProperty{ OutputConfig: &AsyncInferenceOutputConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), NotificationConfig: &AsyncInferenceNotificationConfigProperty{ ErrorTopic: jsii.String("errorTopic"), IncludeInferenceResponseIn: []*string{ jsii.String("includeInferenceResponseIn"), }, SuccessTopic: jsii.String("successTopic"), }, S3FailurePath: jsii.String("s3FailurePath"), S3OutputPath: jsii.String("s3OutputPath"), }, // the properties below are optional ClientConfig: &AsyncInferenceClientConfigProperty{ MaxConcurrentInvocationsPerInstance: jsii.Number(123), }, }, DataCaptureConfig: &DataCaptureConfigProperty{ CaptureOptions: []interface{}{ &CaptureOptionProperty{ CaptureMode: jsii.String("captureMode"), }, }, DestinationS3Uri: jsii.String("destinationS3Uri"), InitialSamplingPercentage: jsii.Number(123), // the properties below are optional CaptureContentTypeHeader: &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }, EnableCapture: jsii.Boolean(false), KmsKeyId: jsii.String("kmsKeyId"), }, EnableNetworkIsolation: jsii.Boolean(false), EndpointConfigName: jsii.String("endpointConfigName"), ExecutionRoleArn: jsii.String("executionRoleArn"), ExplainerConfig: &ExplainerConfigProperty{ ClarifyExplainerConfig: &ClarifyExplainerConfigProperty{ ShapConfig: &ClarifyShapConfigProperty{ ShapBaselineConfig: &ClarifyShapBaselineConfigProperty{ MimeType: jsii.String("mimeType"), ShapBaseline: jsii.String("shapBaseline"), ShapBaselineUri: jsii.String("shapBaselineUri"), }, // the properties below are optional NumberOfSamples: jsii.Number(123), Seed: jsii.Number(123), TextConfig: &ClarifyTextConfigProperty{ Granularity: jsii.String("granularity"), Language: jsii.String("language"), }, UseLogit: jsii.Boolean(false), }, // the properties below are optional EnableExplanations: jsii.String("enableExplanations"), InferenceConfig: &ClarifyInferenceConfigProperty{ ContentTemplate: jsii.String("contentTemplate"), FeatureHeaders: []*string{ jsii.String("featureHeaders"), }, FeaturesAttribute: jsii.String("featuresAttribute"), FeatureTypes: []*string{ jsii.String("featureTypes"), }, LabelAttribute: jsii.String("labelAttribute"), LabelHeaders: []*string{ jsii.String("labelHeaders"), }, LabelIndex: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), MaxRecordCount: jsii.Number(123), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityIndex: jsii.Number(123), }, }, }, KmsKeyId: jsii.String("kmsKeyId"), ShadowProductionVariants: []interface{}{ &ProductionVariantProperty{ VariantName: jsii.String("variantName"), // the properties below are optional AcceleratorType: jsii.String("acceleratorType"), ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), EnableSsmAccess: jsii.Boolean(false), InitialInstanceCount: jsii.Number(123), InitialVariantWeight: jsii.Number(123), InstanceType: jsii.String("instanceType"), ManagedInstanceScaling: &ManagedInstanceScalingProperty{ MaxInstanceCount: jsii.Number(123), MinInstanceCount: jsii.Number(123), Status: jsii.String("status"), }, ModelDataDownloadTimeoutInSeconds: jsii.Number(123), ModelName: jsii.String("modelName"), RoutingConfig: &RoutingConfigProperty{ RoutingStrategy: jsii.String("routingStrategy"), }, ServerlessConfig: &ServerlessConfigProperty{ MaxConcurrency: jsii.Number(123), MemorySizeInMb: jsii.Number(123), // the properties below are optional ProvisionedConcurrency: jsii.Number(123), }, VolumeSizeInGb: jsii.Number(123), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, })
func NewCfnEndpointConfig ¶
func NewCfnEndpointConfig(scope constructs.Construct, id *string, props *CfnEndpointConfigProps) CfnEndpointConfig
type CfnEndpointConfigProps ¶
type CfnEndpointConfigProps struct { // A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-productionvariants // ProductionVariants interface{} `field:"required" json:"productionVariants" yaml:"productionVariants"` // Specifies configuration for how an endpoint performs asynchronous inference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig // AsyncInferenceConfig interface{} `field:"optional" json:"asyncInferenceConfig" yaml:"asyncInferenceConfig"` // Specifies how to capture endpoint data for model monitor. // // The data capture configuration applies to all production variants hosted at the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig // DataCaptureConfig interface{} `field:"optional" json:"dataCaptureConfig" yaml:"dataCaptureConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"enableNetworkIsolation"` // The name of the endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-endpointconfigname // EndpointConfigName *string `field:"optional" json:"endpointConfigName" yaml:"endpointConfigName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-executionrolearn // ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"` // A parameter to activate explainers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-explainerconfig // ExplainerConfig interface{} `field:"optional" json:"explainerConfig" yaml:"explainerConfig"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Array of `ProductionVariant` objects. // // There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants` . If you use this field, you can only specify one variant for `ProductionVariants` and one variant for `ShadowProductionVariants` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-shadowproductionvariants // ShadowProductionVariants interface{} `field:"optional" json:"shadowProductionVariants" yaml:"shadowProductionVariants"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"` }
Properties for defining a `CfnEndpointConfig`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEndpointConfigProps := &CfnEndpointConfigProps{ ProductionVariants: []interface{}{ &ProductionVariantProperty{ VariantName: jsii.String("variantName"), // the properties below are optional AcceleratorType: jsii.String("acceleratorType"), ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), EnableSsmAccess: jsii.Boolean(false), InitialInstanceCount: jsii.Number(123), InitialVariantWeight: jsii.Number(123), InstanceType: jsii.String("instanceType"), ManagedInstanceScaling: &ManagedInstanceScalingProperty{ MaxInstanceCount: jsii.Number(123), MinInstanceCount: jsii.Number(123), Status: jsii.String("status"), }, ModelDataDownloadTimeoutInSeconds: jsii.Number(123), ModelName: jsii.String("modelName"), RoutingConfig: &RoutingConfigProperty{ RoutingStrategy: jsii.String("routingStrategy"), }, ServerlessConfig: &ServerlessConfigProperty{ MaxConcurrency: jsii.Number(123), MemorySizeInMb: jsii.Number(123), // the properties below are optional ProvisionedConcurrency: jsii.Number(123), }, VolumeSizeInGb: jsii.Number(123), }, }, // the properties below are optional AsyncInferenceConfig: &AsyncInferenceConfigProperty{ OutputConfig: &AsyncInferenceOutputConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), NotificationConfig: &AsyncInferenceNotificationConfigProperty{ ErrorTopic: jsii.String("errorTopic"), IncludeInferenceResponseIn: []*string{ jsii.String("includeInferenceResponseIn"), }, SuccessTopic: jsii.String("successTopic"), }, S3FailurePath: jsii.String("s3FailurePath"), S3OutputPath: jsii.String("s3OutputPath"), }, // the properties below are optional ClientConfig: &AsyncInferenceClientConfigProperty{ MaxConcurrentInvocationsPerInstance: jsii.Number(123), }, }, DataCaptureConfig: &DataCaptureConfigProperty{ CaptureOptions: []interface{}{ &CaptureOptionProperty{ CaptureMode: jsii.String("captureMode"), }, }, DestinationS3Uri: jsii.String("destinationS3Uri"), InitialSamplingPercentage: jsii.Number(123), // the properties below are optional CaptureContentTypeHeader: &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }, EnableCapture: jsii.Boolean(false), KmsKeyId: jsii.String("kmsKeyId"), }, EnableNetworkIsolation: jsii.Boolean(false), EndpointConfigName: jsii.String("endpointConfigName"), ExecutionRoleArn: jsii.String("executionRoleArn"), ExplainerConfig: &ExplainerConfigProperty{ ClarifyExplainerConfig: &ClarifyExplainerConfigProperty{ ShapConfig: &ClarifyShapConfigProperty{ ShapBaselineConfig: &ClarifyShapBaselineConfigProperty{ MimeType: jsii.String("mimeType"), ShapBaseline: jsii.String("shapBaseline"), ShapBaselineUri: jsii.String("shapBaselineUri"), }, // the properties below are optional NumberOfSamples: jsii.Number(123), Seed: jsii.Number(123), TextConfig: &ClarifyTextConfigProperty{ Granularity: jsii.String("granularity"), Language: jsii.String("language"), }, UseLogit: jsii.Boolean(false), }, // the properties below are optional EnableExplanations: jsii.String("enableExplanations"), InferenceConfig: &ClarifyInferenceConfigProperty{ ContentTemplate: jsii.String("contentTemplate"), FeatureHeaders: []*string{ jsii.String("featureHeaders"), }, FeaturesAttribute: jsii.String("featuresAttribute"), FeatureTypes: []*string{ jsii.String("featureTypes"), }, LabelAttribute: jsii.String("labelAttribute"), LabelHeaders: []*string{ jsii.String("labelHeaders"), }, LabelIndex: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), MaxRecordCount: jsii.Number(123), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityIndex: jsii.Number(123), }, }, }, KmsKeyId: jsii.String("kmsKeyId"), ShadowProductionVariants: []interface{}{ &ProductionVariantProperty{ VariantName: jsii.String("variantName"), // the properties below are optional AcceleratorType: jsii.String("acceleratorType"), ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), EnableSsmAccess: jsii.Boolean(false), InitialInstanceCount: jsii.Number(123), InitialVariantWeight: jsii.Number(123), InstanceType: jsii.String("instanceType"), ManagedInstanceScaling: &ManagedInstanceScalingProperty{ MaxInstanceCount: jsii.Number(123), MinInstanceCount: jsii.Number(123), Status: jsii.String("status"), }, ModelDataDownloadTimeoutInSeconds: jsii.Number(123), ModelName: jsii.String("modelName"), RoutingConfig: &RoutingConfigProperty{ RoutingStrategy: jsii.String("routingStrategy"), }, ServerlessConfig: &ServerlessConfigProperty{ MaxConcurrency: jsii.Number(123), MemorySizeInMb: jsii.Number(123), // the properties below are optional ProvisionedConcurrency: jsii.Number(123), }, VolumeSizeInGb: jsii.Number(123), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceclientconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceclientconfig-maxconcurrentinvocationsperinstance // MaxConcurrentInvocationsPerInstance *float64 `field:"optional" json:"maxConcurrentInvocationsPerInstance" yaml:"maxConcurrentInvocationsPerInstance"` }
Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" asyncInferenceClientConfigProperty := &AsyncInferenceClientConfigProperty{ MaxConcurrentInvocationsPerInstance: jsii.Number(123), }
type CfnEndpointConfig_AsyncInferenceConfigProperty ¶
type CfnEndpointConfig_AsyncInferenceConfigProperty struct { // Specifies the configuration for asynchronous inference invocation outputs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig-outputconfig // OutputConfig interface{} `field:"required" json:"outputConfig" yaml:"outputConfig"` // Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig-clientconfig // ClientConfig interface{} `field:"optional" json:"clientConfig" yaml:"clientConfig"` }
Specifies configuration for how an endpoint performs asynchronous inference.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" asyncInferenceConfigProperty := &AsyncInferenceConfigProperty{ OutputConfig: &AsyncInferenceOutputConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), NotificationConfig: &AsyncInferenceNotificationConfigProperty{ ErrorTopic: jsii.String("errorTopic"), IncludeInferenceResponseIn: []*string{ jsii.String("includeInferenceResponseIn"), }, SuccessTopic: jsii.String("successTopic"), }, S3FailurePath: jsii.String("s3FailurePath"), S3OutputPath: jsii.String("s3OutputPath"), }, // the properties below are optional ClientConfig: &AsyncInferenceClientConfigProperty{ MaxConcurrentInvocationsPerInstance: jsii.Number(123), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html#cfn-sagemaker-endpointconfig-asyncinferencenotificationconfig-errortopic // ErrorTopic *string `field:"optional" json:"errorTopic" yaml:"errorTopic"` // The Amazon SNS topics where you want the inference response to be included. // // > The inference response is included only if the response size is less than or equal to 128 KB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html#cfn-sagemaker-endpointconfig-asyncinferencenotificationconfig-includeinferenceresponsein // IncludeInferenceResponseIn *[]*string `field:"optional" json:"includeInferenceResponseIn" yaml:"includeInferenceResponseIn"` // Amazon SNS topic to post a notification to when an inference completes successfully. // // If no topic is provided, no notification is sent on success. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferencenotificationconfig.html#cfn-sagemaker-endpointconfig-asyncinferencenotificationconfig-successtopic // SuccessTopic *string `field:"optional" json:"successTopic" yaml:"successTopic"` }
Specifies the configuration for notifications of inference results for asynchronous inference.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" asyncInferenceNotificationConfigProperty := &AsyncInferenceNotificationConfigProperty{ ErrorTopic: jsii.String("errorTopic"), IncludeInferenceResponseIn: []*string{ jsii.String("includeInferenceResponseIn"), }, SuccessTopic: jsii.String("successTopic"), }
type CfnEndpointConfig_AsyncInferenceOutputConfigProperty ¶
type CfnEndpointConfig_AsyncInferenceOutputConfigProperty struct { // The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Specifies the configuration for notifications of inference results for asynchronous inference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-notificationconfig // NotificationConfig interface{} `field:"optional" json:"notificationConfig" yaml:"notificationConfig"` // The Amazon S3 location to upload failure inference responses to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-s3failurepath // S3FailurePath *string `field:"optional" json:"s3FailurePath" yaml:"s3FailurePath"` // The Amazon S3 location to upload inference responses to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceoutputconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceoutputconfig-s3outputpath // S3OutputPath *string `field:"optional" json:"s3OutputPath" yaml:"s3OutputPath"` }
Specifies the configuration for asynchronous inference invocation outputs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" asyncInferenceOutputConfigProperty := &AsyncInferenceOutputConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), NotificationConfig: &AsyncInferenceNotificationConfigProperty{ ErrorTopic: jsii.String("errorTopic"), IncludeInferenceResponseIn: []*string{ jsii.String("includeInferenceResponseIn"), }, SuccessTopic: jsii.String("successTopic"), }, S3FailurePath: jsii.String("s3FailurePath"), S3OutputPath: jsii.String("s3OutputPath"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-capturecontenttypeheader.html#cfn-sagemaker-endpointconfig-capturecontenttypeheader-csvcontenttypes // CsvContentTypes *[]*string `field:"optional" json:"csvContentTypes" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-capturecontenttypeheader.html#cfn-sagemaker-endpointconfig-capturecontenttypeheader-jsoncontenttypes // JsonContentTypes *[]*string `field:"optional" json:"jsonContentTypes" yaml:"jsonContentTypes"` }
Specifies the JSON and CSV content types of the data that the endpoint captures.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" captureContentTypeHeaderProperty := &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }
type CfnEndpointConfig_CaptureOptionProperty ¶
type CfnEndpointConfig_CaptureOptionProperty struct { // Specifies whether the endpoint captures input data or output data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-captureoption.html#cfn-sagemaker-endpointconfig-captureoption-capturemode // CaptureMode *string `field:"required" json:"captureMode" yaml:"captureMode"` }
Specifies whether the endpoint captures input data or output data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" captureOptionProperty := &CaptureOptionProperty{ CaptureMode: jsii.String("captureMode"), }
type CfnEndpointConfig_ClarifyExplainerConfigProperty ¶ added in v2.45.0
type CfnEndpointConfig_ClarifyExplainerConfigProperty struct { // The configuration for SHAP analysis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html#cfn-sagemaker-endpointconfig-clarifyexplainerconfig-shapconfig // ShapConfig interface{} `field:"required" json:"shapConfig" yaml:"shapConfig"` // A JMESPath boolean expression used to filter which records to explain. // // Explanations are activated by default. See [`EnableExplanations`](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable) for additional information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html#cfn-sagemaker-endpointconfig-clarifyexplainerconfig-enableexplanations // EnableExplanations *string `field:"optional" json:"enableExplanations" yaml:"enableExplanations"` // The inference configuration parameter for the model container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html#cfn-sagemaker-endpointconfig-clarifyexplainerconfig-inferenceconfig // InferenceConfig interface{} `field:"optional" json:"inferenceConfig" yaml:"inferenceConfig"` }
The configuration parameters for the SageMaker Clarify explainer.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clarifyExplainerConfigProperty := &ClarifyExplainerConfigProperty{ ShapConfig: &ClarifyShapConfigProperty{ ShapBaselineConfig: &ClarifyShapBaselineConfigProperty{ MimeType: jsii.String("mimeType"), ShapBaseline: jsii.String("shapBaseline"), ShapBaselineUri: jsii.String("shapBaselineUri"), }, // the properties below are optional NumberOfSamples: jsii.Number(123), Seed: jsii.Number(123), TextConfig: &ClarifyTextConfigProperty{ Granularity: jsii.String("granularity"), Language: jsii.String("language"), }, UseLogit: jsii.Boolean(false), }, // the properties below are optional EnableExplanations: jsii.String("enableExplanations"), InferenceConfig: &ClarifyInferenceConfigProperty{ ContentTemplate: jsii.String("contentTemplate"), FeatureHeaders: []*string{ jsii.String("featureHeaders"), }, FeaturesAttribute: jsii.String("featuresAttribute"), FeatureTypes: []*string{ jsii.String("featureTypes"), }, LabelAttribute: jsii.String("labelAttribute"), LabelHeaders: []*string{ jsii.String("labelHeaders"), }, LabelIndex: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), MaxRecordCount: jsii.Number(123), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityIndex: jsii.Number(123), }, }
type CfnEndpointConfig_ClarifyInferenceConfigProperty ¶ added in v2.45.0
type CfnEndpointConfig_ClarifyInferenceConfigProperty struct { // A template string used to format a JSON record into an acceptable model container input. // // For example, a `ContentTemplate` string `'{"myfeatures":$features}'` will format a list of features `[1,2,3]` into the record string `'{"myfeatures":[1,2,3]}'` . Required only when the model container input is in JSON Lines format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-contenttemplate // ContentTemplate *string `field:"optional" json:"contentTemplate" yaml:"contentTemplate"` // The names of the features. // // If provided, these are included in the endpoint response payload to help readability of the `InvokeEndpoint` output. See the [Response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under *Invoke the endpoint* in the Developer Guide for more information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featureheaders // FeatureHeaders *[]*string `field:"optional" json:"featureHeaders" yaml:"featureHeaders"` // Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. // // For example, if `FeaturesAttribute` is the JMESPath expression `'myfeatures'` , it extracts a list of features `[1,2,3]` from request data `'{"myfeatures":[1,2,3]}'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featuresattribute // FeaturesAttribute *string `field:"optional" json:"featuresAttribute" yaml:"featuresAttribute"` // A list of data types of the features (optional). // // Applicable only to NLP explainability. If provided, `FeatureTypes` must have at least one `'text'` string (for example, `['text']` ). If `FeatureTypes` is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the [response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under *Invoke the endpoint* in the Developer Guide for more information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featuretypes // FeatureTypes *[]*string `field:"optional" json:"featureTypes" yaml:"featureTypes"` // A JMESPath expression used to locate the list of label headers in the model container output. // // *Example* : If the model container output of a batch request is `'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}'` , then set `LabelAttribute` to `'labels'` to extract the list of label headers `["cat","dog","fish"]` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelattribute // LabelAttribute *string `field:"optional" json:"labelAttribute" yaml:"labelAttribute"` // For multiclass classification problems, the label headers are the names of the classes. // // Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the `InvokeEndpoint` API. See the [response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under *Invoke the endpoint* in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelheaders // LabelHeaders *[]*string `field:"optional" json:"labelHeaders" yaml:"labelHeaders"` // A zero-based index used to extract a label header or list of label headers from model container output in CSV format. // // *Example for a multiclass model:* If the model container output consists of label headers followed by probabilities: `'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'` , set `LabelIndex` to `0` to select the label headers `['cat','dog','fish']` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelindex // LabelIndex *float64 `field:"optional" json:"labelIndex" yaml:"labelIndex"` // The maximum payload size (MB) allowed of a request from the explainer to the model container. // // Defaults to `6` MB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-maxpayloadinmb // MaxPayloadInMb *float64 `field:"optional" json:"maxPayloadInMb" yaml:"maxPayloadInMb"` // The maximum number of records in a request that the model container can process when querying the model container for the predictions of a [synthetic dataset](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic) . A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If `MaxRecordCount` is `1` , the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-maxrecordcount // MaxRecordCount *float64 `field:"optional" json:"maxRecordCount" yaml:"maxRecordCount"` // A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format. // // *Example* : If the model container output of a single request is `'{"predicted_label":1,"probability":0.6}'` , then set `ProbabilityAttribute` to `'probability'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // A zero-based index used to extract a probability value (score) or list from model container output in CSV format. // // If this value is not provided, the entire model container output will be treated as a probability value (score) or list. // // *Example for a single class model:* If the model container output consists of a string-formatted prediction label followed by its probability: `'1,0.6'` , set `ProbabilityIndex` to `1` to select the probability value `0.6` . // // *Example for a multiclass model:* If the model container output consists of a string-formatted prediction label followed by its probability: `'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'` , set `ProbabilityIndex` to `1` to select the probability values `[0.1,0.6,0.3]` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-probabilityindex // ProbabilityIndex *float64 `field:"optional" json:"probabilityIndex" yaml:"probabilityIndex"` }
The inference configuration parameter for the model container.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clarifyInferenceConfigProperty := &ClarifyInferenceConfigProperty{ ContentTemplate: jsii.String("contentTemplate"), FeatureHeaders: []*string{ jsii.String("featureHeaders"), }, FeaturesAttribute: jsii.String("featuresAttribute"), FeatureTypes: []*string{ jsii.String("featureTypes"), }, LabelAttribute: jsii.String("labelAttribute"), LabelHeaders: []*string{ jsii.String("labelHeaders"), }, LabelIndex: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), MaxRecordCount: jsii.Number(123), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityIndex: jsii.Number(123), }
type CfnEndpointConfig_ClarifyShapBaselineConfigProperty ¶ added in v2.45.0
type CfnEndpointConfig_ClarifyShapBaselineConfigProperty struct { // The MIME type of the baseline data. // // Choose from `'text/csv'` or `'application/jsonlines'` . Defaults to `'text/csv'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-mimetype // MimeType *string `field:"optional" json:"mimeType" yaml:"mimeType"` // The inline SHAP baseline data in string format. // // `ShapBaseline` can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the `Granularity` of the `TextConfig` parameter. The size limit for `ShapBasline` is 4 KB. Use the `ShapBaselineUri` parameter if you want to provide more than 4 KB of baseline data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-shapbaseline // ShapBaseline *string `field:"optional" json:"shapBaseline" yaml:"shapBaseline"` // The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. // // The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the `ShapBaselineUri` should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see [Give SageMaker access to Resources in your Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-shapbaselineuri // ShapBaselineUri *string `field:"optional" json:"shapBaselineUri" yaml:"shapBaselineUri"` }
The configuration for the [SHAP baseline](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html) (also called the background or reference dataset) of the Kernal SHAP algorithm.
> - The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the *Synthetic data* of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) . > - `ShapBaseline` and `ShapBaselineUri` are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clarifyShapBaselineConfigProperty := &ClarifyShapBaselineConfigProperty{ MimeType: jsii.String("mimeType"), ShapBaseline: jsii.String("shapBaseline"), ShapBaselineUri: jsii.String("shapBaselineUri"), }
type CfnEndpointConfig_ClarifyShapConfigProperty ¶ added in v2.45.0
type CfnEndpointConfig_ClarifyShapConfigProperty struct { // The configuration for the SHAP baseline of the Kernal SHAP algorithm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-shapbaselineconfig // ShapBaselineConfig interface{} `field:"required" json:"shapBaselineConfig" yaml:"shapBaselineConfig"` // The number of samples to be used for analysis by the Kernal SHAP algorithm. // // > The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the *Synthetic data* of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-numberofsamples // NumberOfSamples *float64 `field:"optional" json:"numberOfSamples" yaml:"numberOfSamples"` // The starting value used to initialize the random number generator in the explainer. // // Provide a value for this parameter to obtain a deterministic SHAP result. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-seed // Seed *float64 `field:"optional" json:"seed" yaml:"seed"` // A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. // // Required for natural language processing (NLP) explainability only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-textconfig // TextConfig interface{} `field:"optional" json:"textConfig" yaml:"textConfig"` // A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. // // Defaults to false. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html#cfn-sagemaker-endpointconfig-clarifyshapconfig-uselogit // UseLogit interface{} `field:"optional" json:"useLogit" yaml:"useLogit"` }
The configuration for SHAP analysis using SageMaker Clarify Explainer.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clarifyShapConfigProperty := &ClarifyShapConfigProperty{ ShapBaselineConfig: &ClarifyShapBaselineConfigProperty{ MimeType: jsii.String("mimeType"), ShapBaseline: jsii.String("shapBaseline"), ShapBaselineUri: jsii.String("shapBaselineUri"), }, // the properties below are optional NumberOfSamples: jsii.Number(123), Seed: jsii.Number(123), TextConfig: &ClarifyTextConfigProperty{ Granularity: jsii.String("granularity"), Language: jsii.String("language"), }, UseLogit: jsii.Boolean(false), }
type CfnEndpointConfig_ClarifyTextConfigProperty ¶ added in v2.45.0
type CfnEndpointConfig_ClarifyTextConfigProperty struct { // The unit of granularity for the analysis of text features. // // For example, if the unit is `'token'` , then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html#cfn-sagemaker-endpointconfig-clarifytextconfig-granularity // Granularity *string `field:"required" json:"granularity" yaml:"granularity"` // Specifies the language of the text features in [ISO 639-1](https://docs.aws.amazon.com/ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or [ISO 639-3](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_639-3) code of a supported language. // // > For a mix of multiple languages, use code `'xx'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html#cfn-sagemaker-endpointconfig-clarifytextconfig-language // Language *string `field:"required" json:"language" yaml:"language"` }
A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text.
Required only for natural language processing (NLP) explainability.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clarifyTextConfigProperty := &ClarifyTextConfigProperty{ Granularity: jsii.String("granularity"), Language: jsii.String("language"), }
type CfnEndpointConfig_DataCaptureConfigProperty ¶
type CfnEndpointConfig_DataCaptureConfigProperty struct { // Specifies whether the endpoint captures input data to your model, output data from your model, or both. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-captureoptions // CaptureOptions interface{} `field:"required" json:"captureOptions" yaml:"captureOptions"` // The S3 bucket where model monitor stores captured data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-destinations3uri // DestinationS3Uri *string `field:"required" json:"destinationS3Uri" yaml:"destinationS3Uri"` // The percentage of data to capture. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-initialsamplingpercentage // InitialSamplingPercentage *float64 `field:"required" json:"initialSamplingPercentage" yaml:"initialSamplingPercentage"` // A list of the JSON and CSV content type that the endpoint captures. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader // CaptureContentTypeHeader interface{} `field:"optional" json:"captureContentTypeHeader" yaml:"captureContentTypeHeader"` // Set to `True` to enable data capture. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-enablecapture // EnableCapture interface{} `field:"optional" json:"enableCapture" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
Specifies the configuration of your endpoint for model monitor data capture.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataCaptureConfigProperty := &DataCaptureConfigProperty{ CaptureOptions: []interface{}{ &CaptureOptionProperty{ CaptureMode: jsii.String("captureMode"), }, }, DestinationS3Uri: jsii.String("destinationS3Uri"), InitialSamplingPercentage: jsii.Number(123), // the properties below are optional CaptureContentTypeHeader: &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }, EnableCapture: jsii.Boolean(false), KmsKeyId: jsii.String("kmsKeyId"), }
type CfnEndpointConfig_ExplainerConfigProperty ¶ added in v2.46.0
type CfnEndpointConfig_ExplainerConfigProperty struct { // A member of `ExplainerConfig` that contains configuration parameters for the SageMaker Clarify explainer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-explainerconfig.html#cfn-sagemaker-endpointconfig-explainerconfig-clarifyexplainerconfig // ClarifyExplainerConfig interface{} `field:"optional" json:"clarifyExplainerConfig" yaml:"clarifyExplainerConfig"` }
A parameter to activate explainers.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" explainerConfigProperty := &ExplainerConfigProperty{ ClarifyExplainerConfig: &ClarifyExplainerConfigProperty{ ShapConfig: &ClarifyShapConfigProperty{ ShapBaselineConfig: &ClarifyShapBaselineConfigProperty{ MimeType: jsii.String("mimeType"), ShapBaseline: jsii.String("shapBaseline"), ShapBaselineUri: jsii.String("shapBaselineUri"), }, // the properties below are optional NumberOfSamples: jsii.Number(123), Seed: jsii.Number(123), TextConfig: &ClarifyTextConfigProperty{ Granularity: jsii.String("granularity"), Language: jsii.String("language"), }, UseLogit: jsii.Boolean(false), }, // the properties below are optional EnableExplanations: jsii.String("enableExplanations"), InferenceConfig: &ClarifyInferenceConfigProperty{ ContentTemplate: jsii.String("contentTemplate"), FeatureHeaders: []*string{ jsii.String("featureHeaders"), }, FeaturesAttribute: jsii.String("featuresAttribute"), FeatureTypes: []*string{ jsii.String("featureTypes"), }, LabelAttribute: jsii.String("labelAttribute"), LabelHeaders: []*string{ jsii.String("labelHeaders"), }, LabelIndex: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), MaxRecordCount: jsii.Number(123), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityIndex: jsii.Number(123), }, }, }
type CfnEndpointConfig_ManagedInstanceScalingProperty ¶ added in v2.114.0
type CfnEndpointConfig_ManagedInstanceScalingProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-managedinstancescaling.html#cfn-sagemaker-endpointconfig-managedinstancescaling-maxinstancecount // MaxInstanceCount *float64 `field:"optional" json:"maxInstanceCount" yaml:"maxInstanceCount"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-managedinstancescaling.html#cfn-sagemaker-endpointconfig-managedinstancescaling-mininstancecount // MinInstanceCount *float64 `field:"optional" json:"minInstanceCount" yaml:"minInstanceCount"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-managedinstancescaling.html#cfn-sagemaker-endpointconfig-managedinstancescaling-status // Status *string `field:"optional" json:"status" yaml:"status"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" managedInstanceScalingProperty := &ManagedInstanceScalingProperty{ MaxInstanceCount: jsii.Number(123), MinInstanceCount: jsii.Number(123), Status: jsii.String("status"), }
type CfnEndpointConfig_ProductionVariantProperty ¶
type CfnEndpointConfig_ProductionVariantProperty struct { // The name of the production variant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-variantname // VariantName *string `field:"required" json:"variantName" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-acceleratortype // AcceleratorType *string `field:"optional" json:"acceleratorType" yaml:"acceleratorType"` // The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. // // For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-containerstartuphealthchecktimeoutinseconds // ContainerStartupHealthCheckTimeoutInSeconds *float64 `field:"optional" json:"containerStartupHealthCheckTimeoutInSeconds" yaml:"containerStartupHealthCheckTimeoutInSeconds"` // You can use this parameter to turn on native AWS Systems Manager (SSM) access for a production variant behind an endpoint. // // By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling `UpdateEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-enablessmaccess // EnableSsmAccess interface{} `field:"optional" json:"enableSsmAccess" yaml:"enableSsmAccess"` // Number of instances to launch initially. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialinstancecount // InitialInstanceCount *float64 `field:"optional" json:"initialInstanceCount" yaml:"initialInstanceCount"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialvariantweight // InitialVariantWeight *float64 `field:"optional" json:"initialVariantWeight" yaml:"initialVariantWeight"` // The ML compute instance type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-instancetype // InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-managedinstancescaling // ManagedInstanceScaling interface{} `field:"optional" json:"managedInstanceScaling" yaml:"managedInstanceScaling"` // The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-modeldatadownloadtimeoutinseconds // ModelDataDownloadTimeoutInSeconds *float64 `field:"optional" json:"modelDataDownloadTimeoutInSeconds" yaml:"modelDataDownloadTimeoutInSeconds"` // The name of the model that you want to host. // // This is the name that you specified when creating the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-modelname // ModelName *string `field:"optional" json:"modelName" yaml:"modelName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-routingconfig // RoutingConfig interface{} `field:"optional" json:"routingConfig" yaml:"routingConfig"` // The serverless configuration for an endpoint. // // Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-serverlessconfig // ServerlessConfig interface{} `field:"optional" json:"serverlessConfig" yaml:"serverlessConfig"` // The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. // // Currently only Amazon EBS gp2 storage volumes are supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-volumesizeingb // VolumeSizeInGb *float64 `field:"optional" json:"volumeSizeInGb" yaml:"volumeSizeInGb"` }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" productionVariantProperty := &ProductionVariantProperty{ VariantName: jsii.String("variantName"), // the properties below are optional AcceleratorType: jsii.String("acceleratorType"), ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), EnableSsmAccess: jsii.Boolean(false), InitialInstanceCount: jsii.Number(123), InitialVariantWeight: jsii.Number(123), InstanceType: jsii.String("instanceType"), ManagedInstanceScaling: &ManagedInstanceScalingProperty{ MaxInstanceCount: jsii.Number(123), MinInstanceCount: jsii.Number(123), Status: jsii.String("status"), }, ModelDataDownloadTimeoutInSeconds: jsii.Number(123), ModelName: jsii.String("modelName"), RoutingConfig: &RoutingConfigProperty{ RoutingStrategy: jsii.String("routingStrategy"), }, ServerlessConfig: &ServerlessConfigProperty{ MaxConcurrency: jsii.Number(123), MemorySizeInMb: jsii.Number(123), // the properties below are optional ProvisionedConcurrency: jsii.Number(123), }, VolumeSizeInGb: jsii.Number(123), }
type CfnEndpointConfig_RoutingConfigProperty ¶ added in v2.114.0
type CfnEndpointConfig_RoutingConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-routingconfig.html#cfn-sagemaker-endpointconfig-routingconfig-routingstrategy // RoutingStrategy *string `field:"optional" json:"routingStrategy" yaml:"routingStrategy"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" routingConfigProperty := &RoutingConfigProperty{ RoutingStrategy: jsii.String("routingStrategy"), }
type CfnEndpointConfig_ServerlessConfigProperty ¶ added in v2.2.0
type CfnEndpointConfig_ServerlessConfigProperty struct { // The maximum number of concurrent invocations your serverless endpoint can process. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-serverlessconfig.html#cfn-sagemaker-endpointconfig-serverlessconfig-maxconcurrency // MaxConcurrency *float64 `field:"required" json:"maxConcurrency" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-serverlessconfig.html#cfn-sagemaker-endpointconfig-serverlessconfig-memorysizeinmb // MemorySizeInMb *float64 `field:"required" json:"memorySizeInMb" yaml:"memorySizeInMb"` // The amount of provisioned concurrency to allocate for the serverless endpoint. // // Should be less than or equal to `MaxConcurrency` . // // > This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see [CreateInferenceRecommendationsJobs](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-serverlessconfig.html#cfn-sagemaker-endpointconfig-serverlessconfig-provisionedconcurrency // ProvisionedConcurrency *float64 `field:"optional" json:"provisionedConcurrency" yaml:"provisionedConcurrency"` }
Specifies the serverless configuration for an endpoint variant.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serverlessConfigProperty := &ServerlessConfigProperty{ MaxConcurrency: jsii.Number(123), MemorySizeInMb: jsii.Number(123), // the properties below are optional ProvisionedConcurrency: jsii.Number(123), }
type CfnEndpointConfig_VpcConfigProperty ¶ added in v2.114.0
type CfnEndpointConfig_VpcConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-vpcconfig.html#cfn-sagemaker-endpointconfig-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-vpcconfig.html#cfn-sagemaker-endpointconfig-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointconfigname // EndpointConfigName *string `field:"required" json:"endpointConfigName" yaml:"endpointConfigName"` // The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-deploymentconfig // DeploymentConfig interface{} `field:"optional" json:"deploymentConfig" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-excluderetainedvariantproperties // ExcludeRetainedVariantProperties interface{} `field:"optional" json:"excludeRetainedVariantProperties" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-retainallvariantproperties // RetainAllVariantProperties interface{} `field:"optional" json:"retainAllVariantProperties" yaml:"retainAllVariantProperties"` // Specifies whether to reuse the last deployment configuration. // // The default value is false (the configuration is not reused). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-retaindeploymentconfig // RetainDeploymentConfig interface{} `field:"optional" json:"retainDeploymentConfig" yaml:"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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnEndpoint`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEndpointProps := &CfnEndpointProps{ EndpointConfigName: jsii.String("endpointConfigName"), // the properties below are optional DeploymentConfig: &DeploymentConfigProperty{ AutoRollbackConfiguration: &AutoRollbackConfigProperty{ Alarms: []interface{}{ &AlarmProperty{ AlarmName: jsii.String("alarmName"), }, }, }, BlueGreenUpdatePolicy: &BlueGreenUpdatePolicyProperty{ TrafficRoutingConfiguration: &TrafficRoutingConfigProperty{ Type: jsii.String("type"), // the properties below are optional CanarySize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, LinearStepSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), }, // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), TerminationWaitInSeconds: jsii.Number(123), }, RollingUpdatePolicy: &RollingUpdatePolicyProperty{ MaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), RollbackMaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, }, }, EndpointName: jsii.String("endpointName"), ExcludeRetainedVariantProperties: []interface{}{ &VariantPropertyProperty{ VariantPropertyType: jsii.String("variantPropertyType"), }, }, RetainAllVariantProperties: jsii.Boolean(false), RetainDeploymentConfig: jsii.Boolean(false), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html
type CfnEndpoint_AlarmProperty ¶
type CfnEndpoint_AlarmProperty struct { // The name of a CloudWatch alarm in your account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-alarm.html#cfn-sagemaker-endpoint-alarm-alarmname // AlarmName *string `field:"required" json:"alarmName" yaml:"alarmName"` }
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" alarmProperty := &AlarmProperty{ AlarmName: jsii.String("alarmName"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-autorollbackconfig.html#cfn-sagemaker-endpoint-autorollbackconfig-alarms // Alarms interface{} `field:"required" json:"alarms" yaml:"alarms"` }
Automatic rollback configuration for handling endpoint deployment failures and recovery.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" autoRollbackConfigProperty := &AutoRollbackConfigProperty{ Alarms: []interface{}{ &AlarmProperty{ AlarmName: jsii.String("alarmName"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html#cfn-sagemaker-endpoint-bluegreenupdatepolicy-trafficroutingconfiguration // TrafficRoutingConfiguration interface{} `field:"required" json:"trafficRoutingConfiguration" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html#cfn-sagemaker-endpoint-bluegreenupdatepolicy-maximumexecutiontimeoutinseconds // MaximumExecutionTimeoutInSeconds *float64 `field:"optional" json:"maximumExecutionTimeoutInSeconds" yaml:"maximumExecutionTimeoutInSeconds"` // Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. // // Default is 0. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-bluegreenupdatepolicy.html#cfn-sagemaker-endpoint-bluegreenupdatepolicy-terminationwaitinseconds // TerminationWaitInSeconds *float64 `field:"optional" json:"terminationWaitInSeconds" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" blueGreenUpdatePolicyProperty := &BlueGreenUpdatePolicyProperty{ TrafficRoutingConfiguration: &TrafficRoutingConfigProperty{ Type: jsii.String("type"), // the properties below are optional CanarySize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, LinearStepSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), }, // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), TerminationWaitInSeconds: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-capacitysize.html#cfn-sagemaker-endpoint-capacitysize-type // Type *string `field:"required" json:"type" yaml:"type"` // Defines the capacity size, either as a number of instances or a capacity percentage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-capacitysize.html#cfn-sagemaker-endpoint-capacitysize-value // Value *float64 `field:"required" json:"value" yaml:"value"` }
Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy.
You can specify your batches as either instance count or the overall percentage or your fleet.
For a rollback strategy, if you don't specify the fields in this object, or if you set the `Value` to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" capacitySizeProperty := &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }
type CfnEndpoint_DeploymentConfigProperty ¶
type CfnEndpoint_DeploymentConfigProperty struct { // Automatic rollback configuration for handling endpoint deployment failures and recovery. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-autorollbackconfiguration // AutoRollbackConfiguration interface{} `field:"optional" json:"autoRollbackConfiguration" yaml:"autoRollbackConfiguration"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-bluegreenupdatepolicy // BlueGreenUpdatePolicy interface{} `field:"optional" json:"blueGreenUpdatePolicy" yaml:"blueGreenUpdatePolicy"` // Specifies a rolling deployment strategy for updating a SageMaker endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-rollingupdatepolicy // RollingUpdatePolicy interface{} `field:"optional" json:"rollingUpdatePolicy" yaml:"rollingUpdatePolicy"` }
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deploymentConfigProperty := &DeploymentConfigProperty{ AutoRollbackConfiguration: &AutoRollbackConfigProperty{ Alarms: []interface{}{ &AlarmProperty{ AlarmName: jsii.String("alarmName"), }, }, }, BlueGreenUpdatePolicy: &BlueGreenUpdatePolicyProperty{ TrafficRoutingConfiguration: &TrafficRoutingConfigProperty{ Type: jsii.String("type"), // the properties below are optional CanarySize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, LinearStepSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), }, // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), TerminationWaitInSeconds: jsii.Number(123), }, RollingUpdatePolicy: &RollingUpdatePolicyProperty{ MaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), RollbackMaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, }, }
type CfnEndpoint_RollingUpdatePolicyProperty ¶ added in v2.90.0
type CfnEndpoint_RollingUpdatePolicyProperty struct { // Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. // // Value must be between 5% to 50% of the variant's total instance count. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-maximumbatchsize // MaximumBatchSize interface{} `field:"required" json:"maximumBatchSize" yaml:"maximumBatchSize"` // The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-waitintervalinseconds // WaitIntervalInSeconds *float64 `field:"required" json:"waitIntervalInSeconds" yaml:"waitIntervalInSeconds"` // The time limit for the total deployment. // // Exceeding this limit causes a timeout. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-maximumexecutiontimeoutinseconds // MaximumExecutionTimeoutInSeconds *float64 `field:"optional" json:"maximumExecutionTimeoutInSeconds" yaml:"maximumExecutionTimeoutInSeconds"` // Batch size for rollback to the old endpoint fleet. // // Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-rollingupdatepolicy.html#cfn-sagemaker-endpoint-rollingupdatepolicy-rollbackmaximumbatchsize // RollbackMaximumBatchSize interface{} `field:"optional" json:"rollbackMaximumBatchSize" yaml:"rollbackMaximumBatchSize"` }
Specifies a rolling deployment strategy for updating a SageMaker endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rollingUpdatePolicyProperty := &RollingUpdatePolicyProperty{ MaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), // the properties below are optional MaximumExecutionTimeoutInSeconds: jsii.Number(123), RollbackMaximumBatchSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-type // Type *string `field:"required" json:"type" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-canarysize // CanarySize interface{} `field:"optional" json:"canarySize" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-linearstepsize // LinearStepSize interface{} `field:"optional" json:"linearStepSize" yaml:"linearStepSize"` // The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-trafficroutingconfig.html#cfn-sagemaker-endpoint-trafficroutingconfig-waitintervalinseconds // WaitIntervalInSeconds *float64 `field:"optional" json:"waitIntervalInSeconds" yaml:"waitIntervalInSeconds"` }
Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trafficRoutingConfigProperty := &TrafficRoutingConfigProperty{ Type: jsii.String("type"), // the properties below are optional CanarySize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, LinearStepSize: &CapacitySizeProperty{ Type: jsii.String("type"), Value: jsii.Number(123), }, WaitIntervalInSeconds: jsii.Number(123), }
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.) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html#cfn-sagemaker-endpoint-variantproperty-variantpropertytype // VariantPropertyType *string `field:"optional" json:"variantPropertyType" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" variantPropertyProperty := &VariantPropertyProperty{ VariantPropertyType: jsii.String("variantPropertyType"), }
type CfnFeatureGroup ¶
type CfnFeatureGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time a `FeatureGroup` was created. AttrCreationTime() *string // A `FeatureGroup` status. AttrFeatureGroupStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A free form description of a `FeatureGroup` . Description() *string SetDescription(val *string) // The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup` . EventTimeFeatureName() *string SetEventTimeFeatureName(val *string) // A list of `Feature` s. // // Each `Feature` must include a `FeatureName` and a `FeatureType` . FeatureDefinitions() interface{} SetFeatureDefinitions(val interface{}) // The name of the `FeatureGroup` . FeatureGroupName() *string SetFeatureGroupName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The configuration of an `OfflineStore` . OfflineStoreConfig() interface{} SetOfflineStoreConfig(val interface{}) // The configuration of an `OnlineStore` . OnlineStoreConfig() interface{} SetOnlineStoreConfig(val interface{}) // The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` . RecordIdentifierFeatureName() *string SetRecordIdentifierFeatureName(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags used to define a `FeatureGroup` . TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Used to set feature group throughput configuration. ThroughputConfig() interface{} SetThroughputConfig(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var offlineStoreConfig interface{} var onlineStoreConfig interface{} cfnFeatureGroup := awscdk.Aws_sagemaker.NewCfnFeatureGroup(this, jsii.String("MyCfnFeatureGroup"), &CfnFeatureGroupProps{ EventTimeFeatureName: jsii.String("eventTimeFeatureName"), FeatureDefinitions: []interface{}{ &FeatureDefinitionProperty{ FeatureName: jsii.String("featureName"), FeatureType: jsii.String("featureType"), }, }, FeatureGroupName: jsii.String("featureGroupName"), RecordIdentifierFeatureName: jsii.String("recordIdentifierFeatureName"), // the properties below are optional Description: jsii.String("description"), OfflineStoreConfig: offlineStoreConfig, OnlineStoreConfig: onlineStoreConfig, RoleArn: jsii.String("roleArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, ThroughputConfig: &ThroughputConfigProperty{ ThroughputMode: jsii.String("throughputMode"), // the properties below are optional ProvisionedReadCapacityUnits: jsii.Number(123), ProvisionedWriteCapacityUnits: jsii.Number(123), }, })
func NewCfnFeatureGroup ¶
func NewCfnFeatureGroup(scope constructs.Construct, id *string, props *CfnFeatureGroupProps) CfnFeatureGroup
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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-eventtimefeaturename // EventTimeFeatureName *string `field:"required" json:"eventTimeFeatureName" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuredefinitions // FeatureDefinitions interface{} `field:"required" json:"featureDefinitions" yaml:"featureDefinitions"` // The name of the `FeatureGroup` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-featuregroupname // FeatureGroupName *string `field:"required" json:"featureGroupName" yaml:"featureGroupName"` // The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-recordidentifierfeaturename // RecordIdentifierFeatureName *string `field:"required" json:"recordIdentifierFeatureName" yaml:"recordIdentifierFeatureName"` // A free form description of a `FeatureGroup` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-description // Description *string `field:"optional" json:"description" yaml:"description"` // The configuration of an `OfflineStore` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-offlinestoreconfig // OfflineStoreConfig interface{} `field:"optional" json:"offlineStoreConfig" yaml:"offlineStoreConfig"` // The configuration of an `OnlineStore` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-onlinestoreconfig // OnlineStoreConfig interface{} `field:"optional" json:"onlineStoreConfig" yaml:"onlineStoreConfig"` // The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` // Tags used to define a `FeatureGroup` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Used to set feature group throughput configuration. // // There are two modes: `ON_DEMAND` and `PROVISIONED` . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled. // // Note: `PROVISIONED` throughput mode is supported only for feature groups that are offline-only, or use the [`Standard`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-featuregroup.html#cfn-sagemaker-featuregroup-throughputconfig // ThroughputConfig interface{} `field:"optional" json:"throughputConfig" yaml:"throughputConfig"` }
Properties for defining a `CfnFeatureGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var offlineStoreConfig interface{} var onlineStoreConfig interface{} cfnFeatureGroupProps := &CfnFeatureGroupProps{ EventTimeFeatureName: jsii.String("eventTimeFeatureName"), FeatureDefinitions: []interface{}{ &FeatureDefinitionProperty{ FeatureName: jsii.String("featureName"), FeatureType: jsii.String("featureType"), }, }, FeatureGroupName: jsii.String("featureGroupName"), RecordIdentifierFeatureName: jsii.String("recordIdentifierFeatureName"), // the properties below are optional Description: jsii.String("description"), OfflineStoreConfig: offlineStoreConfig, OnlineStoreConfig: onlineStoreConfig, RoleArn: jsii.String("roleArn"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, ThroughputConfig: &ThroughputConfigProperty{ ThroughputMode: jsii.String("throughputMode"), // the properties below are optional ProvisionedReadCapacityUnits: jsii.Number(123), ProvisionedWriteCapacityUnits: jsii.Number(123), }, }
type CfnFeatureGroup_DataCatalogConfigProperty ¶ added in v2.55.0
type CfnFeatureGroup_DataCatalogConfigProperty struct { // The name of the Glue table catalog. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-catalog // Catalog *string `field:"required" json:"catalog" yaml:"catalog"` // The name of the Glue table database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-database // Database *string `field:"required" json:"database" yaml:"database"` // The name of the Glue table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html#cfn-sagemaker-featuregroup-datacatalogconfig-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
The meta data of the Glue table which serves as data catalog for the `OfflineStore` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataCatalogConfigProperty := &DataCatalogConfigProperty{ Catalog: jsii.String("catalog"), Database: jsii.String("database"), TableName: jsii.String("tableName"), }
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` . // // The name: // // - Must start with an alphanumeric character. // - Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html#cfn-sagemaker-featuregroup-featuredefinition-featurename // FeatureName *string `field:"required" json:"featureName" yaml:"featureName"` // The value type of a feature. // // Valid values are Integral, Fractional, or String. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html#cfn-sagemaker-featuregroup-featuredefinition-featuretype // FeatureType *string `field:"required" json:"featureType" yaml:"featureType"` }
A list of features.
You must include `FeatureName` and `FeatureType` . Valid feature `FeatureType` s are `Integral` , `Fractional` and `String` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" featureDefinitionProperty := &FeatureDefinitionProperty{ FeatureName: jsii.String("featureName"), FeatureType: jsii.String("featureType"), }
type CfnFeatureGroup_OfflineStoreConfigProperty ¶ added in v2.55.0
type CfnFeatureGroup_OfflineStoreConfigProperty struct { // The Amazon Simple Storage (Amazon S3) location of `OfflineStore` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-s3storageconfig // S3StorageConfig interface{} `field:"required" json:"s3StorageConfig" yaml:"s3StorageConfig"` // The meta data of the Glue table that is autogenerated when an `OfflineStore` is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-datacatalogconfig // DataCatalogConfig interface{} `field:"optional" json:"dataCatalogConfig" yaml:"dataCatalogConfig"` // Set to `True` to disable the automatic creation of an AWS Glue table when configuring an `OfflineStore` . // // If set to `False` , Feature Store will name the `OfflineStore` Glue table following [Athena's naming recommendations](https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html) . // // The default value is `False` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-disablegluetablecreation // DisableGlueTableCreation interface{} `field:"optional" json:"disableGlueTableCreation" yaml:"disableGlueTableCreation"` // Format for the offline store table. // // Supported formats are Glue (Default) and [Apache Iceberg](https://docs.aws.amazon.com/https://iceberg.apache.org/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html#cfn-sagemaker-featuregroup-offlinestoreconfig-tableformat // TableFormat *string `field:"optional" json:"tableFormat" yaml:"tableFormat"` }
The configuration of an `OfflineStore` .
Provide an `OfflineStoreConfig` in a request to `CreateFeatureGroup` to create an `OfflineStore` .
To encrypt an `OfflineStore` using at rest data encryption, specify AWS Key Management Service (KMS) key ID, or `KMSKeyId` , in `S3StorageConfig` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" offlineStoreConfigProperty := &OfflineStoreConfigProperty{ S3StorageConfig: &S3StorageConfigProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, // the properties below are optional DataCatalogConfig: &DataCatalogConfigProperty{ Catalog: jsii.String("catalog"), Database: jsii.String("database"), TableName: jsii.String("tableName"), }, DisableGlueTableCreation: jsii.Boolean(false), TableFormat: jsii.String("tableFormat"), }
type CfnFeatureGroup_OnlineStoreConfigProperty ¶ added in v2.55.0
type CfnFeatureGroup_OnlineStoreConfigProperty struct { // Turn `OnlineStore` off by specifying `False` for the `EnableOnlineStore` flag. // // Turn `OnlineStore` on by specifying `True` for the `EnableOnlineStore` flag. // // The default value is `False` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-enableonlinestore // EnableOnlineStore interface{} `field:"optional" json:"enableOnlineStore" yaml:"enableOnlineStore"` // Use to specify KMS Key ID ( `KMSKeyId` ) for at-rest encryption of your `OnlineStore` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-securityconfig // SecurityConfig interface{} `field:"optional" json:"securityConfig" yaml:"securityConfig"` // Option for different tiers of low latency storage for real-time data retrieval. // // - `Standard` : A managed low latency data store for feature groups. // - `InMemory` : A managed data store for feature groups that supports very low latency retrieval. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-storagetype // StorageType *string `field:"optional" json:"storageType" yaml:"storageType"` // Time to live duration, where the record is hard deleted after the expiration time is reached; // // `ExpiresAt` = `EventTime` + `TtlDuration` . For information on HardDelete, see the [DeleteRecord](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) API in the Amazon SageMaker API Reference guide. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html#cfn-sagemaker-featuregroup-onlinestoreconfig-ttlduration // TtlDuration interface{} `field:"optional" json:"ttlDuration" yaml:"ttlDuration"` }
Use this to specify the AWS Key Management Service (KMS) Key ID, or `KMSKeyId` , for at rest data encryption.
You can turn `OnlineStore` on or off by specifying the `EnableOnlineStore` flag at General Assembly.
The default value is `False` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" onlineStoreConfigProperty := &OnlineStoreConfigProperty{ EnableOnlineStore: jsii.Boolean(false), SecurityConfig: &OnlineStoreSecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, StorageType: jsii.String("storageType"), TtlDuration: &TtlDurationProperty{ Unit: jsii.String("unit"), Value: jsii.Number(123), }, }
type CfnFeatureGroup_OnlineStoreSecurityConfigProperty ¶ added in v2.55.0
type CfnFeatureGroup_OnlineStoreSecurityConfigProperty struct { // The AWS Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption. // // The caller (either user or IAM role) of `CreateFeatureGroup` must have below permissions to the `OnlineStore` `KmsKeyId` : // // - `"kms:Encrypt"` // - `"kms:Decrypt"` // - `"kms:DescribeKey"` // - `"kms:CreateGrant"` // - `"kms:RetireGrant"` // - `"kms:ReEncryptFrom"` // - `"kms:ReEncryptTo"` // - `"kms:GenerateDataKey"` // - `"kms:ListAliases"` // - `"kms:ListGrants"` // - `"kms:RevokeGrant"` // // The caller (either user or IAM role) to all DataPlane operations ( `PutRecord` , `GetRecord` , `DeleteRecord` ) must have the following permissions to the `KmsKeyId` : // // - `"kms:Decrypt"`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html#cfn-sagemaker-featuregroup-onlinestoresecurityconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The security configuration for `OnlineStore` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" onlineStoreSecurityConfigProperty := &OnlineStoreSecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }
type CfnFeatureGroup_S3StorageConfigProperty ¶ added in v2.55.0
type CfnFeatureGroup_S3StorageConfigProperty struct { // The S3 URI, or location in Amazon S3, of `OfflineStore` . // // S3 URIs have a format similar to the following: `s3://example-bucket/prefix/` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html#cfn-sagemaker-featuregroup-s3storageconfig-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // The AWS Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the `OfflineStore` S3 location. // // The IAM `roleARN` that is passed as a parameter to `CreateFeatureGroup` must have below permissions to the `KmsKeyId` : // // - `"kms:GenerateDataKey"`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html#cfn-sagemaker-featuregroup-s3storageconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The Amazon Simple Storage (Amazon S3) location and security configuration for `OfflineStore` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3StorageConfigProperty := &S3StorageConfigProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnFeatureGroup_ThroughputConfigProperty ¶ added in v2.122.0
type CfnFeatureGroup_ThroughputConfigProperty struct { // The mode used for your feature group throughput: `ON_DEMAND` or `PROVISIONED` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-throughputmode // ThroughputMode *string `field:"required" json:"throughputMode" yaml:"throughputMode"` // For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. // // This field is not applicable for on-demand feature groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedreadcapacityunits // ProvisionedReadCapacityUnits *float64 `field:"optional" json:"provisionedReadCapacityUnits" yaml:"provisionedReadCapacityUnits"` // For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. // // This field is not applicable for on-demand feature groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-throughputconfig.html#cfn-sagemaker-featuregroup-throughputconfig-provisionedwritecapacityunits // ProvisionedWriteCapacityUnits *float64 `field:"optional" json:"provisionedWriteCapacityUnits" yaml:"provisionedWriteCapacityUnits"` }
Used to set feature group throughput configuration.
There are two modes: `ON_DEMAND` and `PROVISIONED` . With on-demand mode, you are charged for data reads and writes that your application performs on your feature group. You do not need to specify read and write throughput because Feature Store accommodates your workloads as they ramp up and down. You can switch a feature group to on-demand only once in a 24 hour period. With provisioned throughput mode, you specify the read and write capacity per second that you expect your application to require, and you are billed based on those limits. Exceeding provisioned throughput will result in your requests being throttled.
Note: `PROVISIONED` throughput mode is supported only for feature groups that are offline-only, or use the [`Standard`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) tier online store.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" throughputConfigProperty := &ThroughputConfigProperty{ ThroughputMode: jsii.String("throughputMode"), // the properties below are optional ProvisionedReadCapacityUnits: jsii.Number(123), ProvisionedWriteCapacityUnits: jsii.Number(123), }
type CfnFeatureGroup_TtlDurationProperty ¶ added in v2.129.0
type CfnFeatureGroup_TtlDurationProperty struct { // `TtlDuration` time unit. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html#cfn-sagemaker-featuregroup-ttlduration-unit // Unit *string `field:"optional" json:"unit" yaml:"unit"` // `TtlDuration` time value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-ttlduration.html#cfn-sagemaker-featuregroup-ttlduration-value // Value *float64 `field:"optional" json:"value" yaml:"value"` }
Time to live duration, where the record is hard deleted after the expiration time is reached;
`ExpiresAt` = `EventTime` + `TtlDuration` . For information on HardDelete, see the [DeleteRecord](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) API in the Amazon SageMaker API Reference guide.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ttlDurationProperty := &TtlDurationProperty{ Unit: jsii.String("unit"), Value: jsii.Number(123), }
type CfnImage ¶
type CfnImage interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the image. // // *Type* : String // // *Length Constraints* : Maximum length of 256. // // *Pattern* : `^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` AttrImageArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the image. ImageDescription() *string SetImageDescription(val *string) // The display name of the image. ImageDisplayName() *string SetImageDisplayName(val *string) // The name of the Image. // // Must be unique by region in your account. ImageName() *string SetImageName(val *string) // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. ImageRoleArn() *string SetImageRoleArn(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a custom SageMaker image.
A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see [Bring your own SageMaker image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnImage := awscdk.Aws_sagemaker.NewCfnImage(this, jsii.String("MyCfnImage"), &CfnImageProps{ ImageName: jsii.String("imageName"), ImageRoleArn: jsii.String("imageRoleArn"), // the properties below are optional ImageDescription: jsii.String("imageDescription"), ImageDisplayName: jsii.String("imageDisplayName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html
func NewCfnImage ¶
func NewCfnImage(scope constructs.Construct, id *string, props *CfnImageProps) CfnImage
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}$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagename // ImageName *string `field:"required" json:"imageName" yaml:"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+=,.@\-_/]+$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagerolearn // ImageRoleArn *string `field:"required" json:"imageRoleArn" yaml:"imageRoleArn"` // The description of the image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedescription // ImageDescription *string `field:"optional" json:"imageDescription" yaml:"imageDescription"` // The display name of the image. // // *Length Constraints* : Minimum length of 1. Maximum length of 128. // // *Pattern* : `^\S(.*\S)?$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedisplayname // ImageDisplayName *string `field:"optional" json:"imageDisplayName" yaml:"imageDisplayName"` // A list of key-value pairs to apply to this resource. // // *Array Members* : Minimum number of 0 items. Maximum number of 50 items. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnImage`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnImageProps := &CfnImageProps{ ImageName: jsii.String("imageName"), ImageRoleArn: jsii.String("imageRoleArn"), // the properties below are optional ImageDescription: jsii.String("imageDescription"), ImageDisplayName: jsii.String("imageDisplayName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html
type CfnImageVersion ¶
type CfnImageVersion interface { awscdk.CfnResource awscdk.IInspectable // The alias of the image version. Alias() *string SetAlias(val *string) // List of aliases for the image version. Aliases() *[]*string SetAliases(val *[]*string) // The URI of the container image version referenced by ImageVersion. AttrContainerImage() *string // The Amazon Resource Name (ARN) of the parent Image. AttrImageArn() *string // The Amazon Resource Name (ARN) of the image version. // // *Type* : String // // *Length Constraints* : Maximum length of 256. // // *Pattern* : `^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])* /[0-9]+$` AttrImageVersionArn() *string // The version of the image. AttrVersion() *float64 // The container image that the SageMaker image version is based on. BaseImage() *string SetBaseImage(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Indicates Horovod compatibility. Horovod() interface{} SetHorovod(val interface{}) // The name of the parent image. ImageName() *string SetImageName(val *string) // Indicates SageMaker job type compatibility. JobType() *string SetJobType(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The machine learning framework vended in the image version. MlFramework() *string SetMlFramework(val *string) // The tree node. Node() constructs.Node // Indicates CPU or GPU compatibility. Processor() *string SetProcessor(val *string) // The supported programming language and its version. ProgrammingLang() *string SetProgrammingLang(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The maintainer description of the image version. ReleaseNotes() *string SetReleaseNotes(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The availability of the image version specified by the maintainer. VendorGuidance() *string SetVendorGuidance(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnImageVersion := awscdk.Aws_sagemaker.NewCfnImageVersion(this, jsii.String("MyCfnImageVersion"), &CfnImageVersionProps{ BaseImage: jsii.String("baseImage"), ImageName: jsii.String("imageName"), // the properties below are optional Alias: jsii.String("alias"), Aliases: []*string{ jsii.String("aliases"), }, Horovod: jsii.Boolean(false), JobType: jsii.String("jobType"), MlFramework: jsii.String("mlFramework"), Processor: jsii.String("processor"), ProgrammingLang: jsii.String("programmingLang"), ReleaseNotes: jsii.String("releaseNotes"), VendorGuidance: jsii.String("vendorGuidance"), })
func NewCfnImageVersion ¶
func NewCfnImageVersion(scope constructs.Construct, id *string, props *CfnImageVersionProps) CfnImageVersion
type CfnImageVersionProps ¶
type CfnImageVersionProps struct { // The container image that the SageMaker image version is based on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-baseimage // BaseImage *string `field:"required" json:"baseImage" yaml:"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}$` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-imagename // ImageName *string `field:"required" json:"imageName" yaml:"imageName"` // The alias of the image version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-alias // Alias *string `field:"optional" json:"alias" yaml:"alias"` // List of aliases for the image version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-aliases // Aliases *[]*string `field:"optional" json:"aliases" yaml:"aliases"` // Indicates Horovod compatibility. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-horovod // Horovod interface{} `field:"optional" json:"horovod" yaml:"horovod"` // Indicates SageMaker job type compatibility. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-jobtype // JobType *string `field:"optional" json:"jobType" yaml:"jobType"` // The machine learning framework vended in the image version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-mlframework // MlFramework *string `field:"optional" json:"mlFramework" yaml:"mlFramework"` // Indicates CPU or GPU compatibility. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-processor // Processor *string `field:"optional" json:"processor" yaml:"processor"` // The supported programming language and its version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-programminglang // ProgrammingLang *string `field:"optional" json:"programmingLang" yaml:"programmingLang"` // The maintainer description of the image version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-releasenotes // ReleaseNotes *string `field:"optional" json:"releaseNotes" yaml:"releaseNotes"` // The availability of the image version specified by the maintainer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-vendorguidance // VendorGuidance *string `field:"optional" json:"vendorGuidance" yaml:"vendorGuidance"` }
Properties for defining a `CfnImageVersion`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnImageVersionProps := &CfnImageVersionProps{ BaseImage: jsii.String("baseImage"), ImageName: jsii.String("imageName"), // the properties below are optional Alias: jsii.String("alias"), Aliases: []*string{ jsii.String("aliases"), }, Horovod: jsii.Boolean(false), JobType: jsii.String("jobType"), MlFramework: jsii.String("mlFramework"), Processor: jsii.String("processor"), ProgrammingLang: jsii.String("programmingLang"), ReleaseNotes: jsii.String("releaseNotes"), VendorGuidance: jsii.String("vendorGuidance"), }
type CfnInferenceComponent ¶ added in v2.113.0
type CfnInferenceComponent interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The time when the inference component was created. AttrCreationTime() *string // The failure reason if the inference component is in a failed state. AttrFailureReason() *string // The Amazon Resource Name (ARN) of the inference component. AttrInferenceComponentArn() *string // The status of the inference component. AttrInferenceComponentStatus() *string // The time when the inference component was last updated. AttrLastModifiedTime() *string // The number of runtime copies of the model container that are currently deployed. AttrRuntimeConfigCurrentCopyCount() *float64 // The number of runtime copies of the model container that you requested to deploy with the inference component. AttrRuntimeConfigDesiredCopyCount() *float64 AttrSpecificationContainerDeployedImage() awscdk.IResolvable // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Amazon Resource Name (ARN) of the endpoint that hosts the inference component. EndpointArn() *string SetEndpointArn(val *string) // The name of the endpoint that hosts the inference component. EndpointName() *string SetEndpointName(val *string) // The name of the inference component. InferenceComponentName() *string SetInferenceComponentName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The runtime config for the inference component. RuntimeConfig() interface{} SetRuntimeConfig(val interface{}) // The specification for the inference component. Specification() interface{} SetSpecification(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An array of tags to apply to the resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The name of the production variant that hosts the inference component. VariantName() *string SetVariantName(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint.
In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInferenceComponent := awscdk.Aws_sagemaker.NewCfnInferenceComponent(this, jsii.String("MyCfnInferenceComponent"), &CfnInferenceComponentProps{ EndpointName: jsii.String("endpointName"), RuntimeConfig: &InferenceComponentRuntimeConfigProperty{ CopyCount: jsii.Number(123), CurrentCopyCount: jsii.Number(123), DesiredCopyCount: jsii.Number(123), }, Specification: &InferenceComponentSpecificationProperty{ ComputeResourceRequirements: &InferenceComponentComputeResourceRequirementsProperty{ MaxMemoryRequiredInMb: jsii.Number(123), MinMemoryRequiredInMb: jsii.Number(123), NumberOfAcceleratorDevicesRequired: jsii.Number(123), NumberOfCpuCoresRequired: jsii.Number(123), }, // the properties below are optional Container: &InferenceComponentContainerSpecificationProperty{ ArtifactUrl: jsii.String("artifactUrl"), DeployedImage: &DeployedImageProperty{ ResolutionTime: jsii.String("resolutionTime"), ResolvedImage: jsii.String("resolvedImage"), SpecifiedImage: jsii.String("specifiedImage"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Image: jsii.String("image"), }, ModelName: jsii.String("modelName"), StartupParameters: &InferenceComponentStartupParametersProperty{ ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), ModelDataDownloadTimeoutInSeconds: jsii.Number(123), }, }, VariantName: jsii.String("variantName"), // the properties below are optional EndpointArn: jsii.String("endpointArn"), InferenceComponentName: jsii.String("inferenceComponentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnInferenceComponent ¶ added in v2.113.0
func NewCfnInferenceComponent(scope constructs.Construct, id *string, props *CfnInferenceComponentProps) CfnInferenceComponent
type CfnInferenceComponentProps ¶ added in v2.113.0
type CfnInferenceComponentProps struct { // The name of the endpoint that hosts the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // The runtime config for the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig // RuntimeConfig interface{} `field:"required" json:"runtimeConfig" yaml:"runtimeConfig"` // The specification for the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification // Specification interface{} `field:"required" json:"specification" yaml:"specification"` // The name of the production variant that hosts the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-variantname // VariantName *string `field:"required" json:"variantName" yaml:"variantName"` // The Amazon Resource Name (ARN) of the endpoint that hosts the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointarn // EndpointArn *string `field:"optional" json:"endpointArn" yaml:"endpointArn"` // The name of the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentname // InferenceComponentName *string `field:"optional" json:"inferenceComponentName" yaml:"inferenceComponentName"` // An array of tags to apply to the resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnInferenceComponent`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInferenceComponentProps := &CfnInferenceComponentProps{ EndpointName: jsii.String("endpointName"), RuntimeConfig: &InferenceComponentRuntimeConfigProperty{ CopyCount: jsii.Number(123), CurrentCopyCount: jsii.Number(123), DesiredCopyCount: jsii.Number(123), }, Specification: &InferenceComponentSpecificationProperty{ ComputeResourceRequirements: &InferenceComponentComputeResourceRequirementsProperty{ MaxMemoryRequiredInMb: jsii.Number(123), MinMemoryRequiredInMb: jsii.Number(123), NumberOfAcceleratorDevicesRequired: jsii.Number(123), NumberOfCpuCoresRequired: jsii.Number(123), }, // the properties below are optional Container: &InferenceComponentContainerSpecificationProperty{ ArtifactUrl: jsii.String("artifactUrl"), DeployedImage: &DeployedImageProperty{ ResolutionTime: jsii.String("resolutionTime"), ResolvedImage: jsii.String("resolvedImage"), SpecifiedImage: jsii.String("specifiedImage"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Image: jsii.String("image"), }, ModelName: jsii.String("modelName"), StartupParameters: &InferenceComponentStartupParametersProperty{ ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), ModelDataDownloadTimeoutInSeconds: jsii.Number(123), }, }, VariantName: jsii.String("variantName"), // the properties below are optional EndpointArn: jsii.String("endpointArn"), InferenceComponentName: jsii.String("inferenceComponentName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnInferenceComponent_DeployedImageProperty ¶ added in v2.113.0
type CfnInferenceComponent_DeployedImageProperty struct { // The date and time when the image path for the model resolved to the `ResolvedImage`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolutiontime // ResolutionTime *string `field:"optional" json:"resolutionTime" yaml:"resolutionTime"` // The specific digest path of the image hosted in this `ProductionVariant` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-resolvedimage // ResolvedImage *string `field:"optional" json:"resolvedImage" yaml:"resolvedImage"` // The image path you specified when you created the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-deployedimage.html#cfn-sagemaker-inferencecomponent-deployedimage-specifiedimage // SpecifiedImage *string `field:"optional" json:"specifiedImage" yaml:"specifiedImage"` }
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this [ProductionVariant](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html) .
If you used the `registry/repository[:tag]` form to specify the image path of the primary container when you created the model hosted in this `ProductionVariant` , the path resolves to a path of the form `registry/repository[@digest]` . A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see [Pulling an Image](https://docs.aws.amazon.com//AmazonECR/latest/userguide/docker-pull-ecr-image.html) in the *Amazon ECR User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deployedImageProperty := &DeployedImageProperty{ ResolutionTime: jsii.String("resolutionTime"), ResolvedImage: jsii.String("resolvedImage"), SpecifiedImage: jsii.String("specifiedImage"), }
type CfnInferenceComponent_InferenceComponentComputeResourceRequirementsProperty ¶ added in v2.113.0
type CfnInferenceComponent_InferenceComponentComputeResourceRequirementsProperty struct { // The maximum MB of memory to allocate to run a model that you assign to an inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-maxmemoryrequiredinmb // MaxMemoryRequiredInMb *float64 `field:"optional" json:"maxMemoryRequiredInMb" yaml:"maxMemoryRequiredInMb"` // The minimum MB of memory to allocate to run a model that you assign to an inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-minmemoryrequiredinmb // MinMemoryRequiredInMb *float64 `field:"optional" json:"minMemoryRequiredInMb" yaml:"minMemoryRequiredInMb"` // The number of accelerators to allocate to run a model that you assign to an inference component. // // Accelerators include GPUs and AWS Inferentia. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofacceleratordevicesrequired // NumberOfAcceleratorDevicesRequired *float64 `field:"optional" json:"numberOfAcceleratorDevicesRequired" yaml:"numberOfAcceleratorDevicesRequired"` // The number of CPU cores to allocate to run a model that you assign to an inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements.html#cfn-sagemaker-inferencecomponent-inferencecomponentcomputeresourcerequirements-numberofcpucoresrequired // NumberOfCpuCoresRequired *float64 `field:"optional" json:"numberOfCpuCoresRequired" yaml:"numberOfCpuCoresRequired"` }
Defines the compute resources to allocate to run a model that you assign to an inference component.
These resources include CPU cores, accelerators, and memory.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceComponentComputeResourceRequirementsProperty := &InferenceComponentComputeResourceRequirementsProperty{ MaxMemoryRequiredInMb: jsii.Number(123), MinMemoryRequiredInMb: jsii.Number(123), NumberOfAcceleratorDevicesRequired: jsii.Number(123), NumberOfCpuCoresRequired: jsii.Number(123), }
type CfnInferenceComponent_InferenceComponentContainerSpecificationProperty ¶ added in v2.113.0
type CfnInferenceComponent_InferenceComponentContainerSpecificationProperty struct { // The Amazon 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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-artifacturl // ArtifactUrl *string `field:"optional" json:"artifactUrl" yaml:"artifactUrl"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-deployedimage // DeployedImage interface{} `field:"optional" json:"deployedImage" yaml:"deployedImage"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentcontainerspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentcontainerspecification-image // Image *string `field:"optional" json:"image" yaml:"image"` }
Defines a container that provides the runtime environment for a model that you deploy with an inference component.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceComponentContainerSpecificationProperty := &InferenceComponentContainerSpecificationProperty{ ArtifactUrl: jsii.String("artifactUrl"), DeployedImage: &DeployedImageProperty{ ResolutionTime: jsii.String("resolutionTime"), ResolvedImage: jsii.String("resolvedImage"), SpecifiedImage: jsii.String("specifiedImage"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Image: jsii.String("image"), }
type CfnInferenceComponent_InferenceComponentRuntimeConfigProperty ¶ added in v2.113.0
type CfnInferenceComponent_InferenceComponentRuntimeConfigProperty struct { // The number of runtime copies of the model container to deploy with the inference component. // // Each copy can serve inference requests. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-copycount // CopyCount *float64 `field:"optional" json:"copyCount" yaml:"copyCount"` // The number of runtime copies of the model container that are currently deployed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-currentcopycount // CurrentCopyCount *float64 `field:"optional" json:"currentCopyCount" yaml:"currentCopyCount"` // The number of runtime copies of the model container that you requested to deploy with the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentruntimeconfig.html#cfn-sagemaker-inferencecomponent-inferencecomponentruntimeconfig-desiredcopycount // DesiredCopyCount *float64 `field:"optional" json:"desiredCopyCount" yaml:"desiredCopyCount"` }
Runtime settings for a model that is deployed with an inference component.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceComponentRuntimeConfigProperty := &InferenceComponentRuntimeConfigProperty{ CopyCount: jsii.Number(123), CurrentCopyCount: jsii.Number(123), DesiredCopyCount: jsii.Number(123), }
type CfnInferenceComponent_InferenceComponentSpecificationProperty ¶ added in v2.113.0
type CfnInferenceComponent_InferenceComponentSpecificationProperty struct { // The compute resources allocated to run the model assigned to the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-computeresourcerequirements // ComputeResourceRequirements interface{} `field:"required" json:"computeResourceRequirements" yaml:"computeResourceRequirements"` // Defines a container that provides the runtime environment for a model that you deploy with an inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-container // Container interface{} `field:"optional" json:"container" yaml:"container"` // The name of an existing SageMaker model object in your account that you want to deploy with the inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-modelname // ModelName *string `field:"optional" json:"modelName" yaml:"modelName"` // Settings that take effect while the model container starts up. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-startupparameters // StartupParameters interface{} `field:"optional" json:"startupParameters" yaml:"startupParameters"` }
Details about the resources to deploy with this inference component, including the model, container, and compute resources.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceComponentSpecificationProperty := &InferenceComponentSpecificationProperty{ ComputeResourceRequirements: &InferenceComponentComputeResourceRequirementsProperty{ MaxMemoryRequiredInMb: jsii.Number(123), MinMemoryRequiredInMb: jsii.Number(123), NumberOfAcceleratorDevicesRequired: jsii.Number(123), NumberOfCpuCoresRequired: jsii.Number(123), }, // the properties below are optional Container: &InferenceComponentContainerSpecificationProperty{ ArtifactUrl: jsii.String("artifactUrl"), DeployedImage: &DeployedImageProperty{ ResolutionTime: jsii.String("resolutionTime"), ResolvedImage: jsii.String("resolvedImage"), SpecifiedImage: jsii.String("specifiedImage"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Image: jsii.String("image"), }, ModelName: jsii.String("modelName"), StartupParameters: &InferenceComponentStartupParametersProperty{ ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), ModelDataDownloadTimeoutInSeconds: jsii.Number(123), }, }
type CfnInferenceComponent_InferenceComponentStartupParametersProperty ¶ added in v2.113.0
type CfnInferenceComponent_InferenceComponentStartupParametersProperty struct { // The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. // // For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-containerstartuphealthchecktimeoutinseconds // ContainerStartupHealthCheckTimeoutInSeconds *float64 `field:"optional" json:"containerStartupHealthCheckTimeoutInSeconds" yaml:"containerStartupHealthCheckTimeoutInSeconds"` // The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentstartupparameters.html#cfn-sagemaker-inferencecomponent-inferencecomponentstartupparameters-modeldatadownloadtimeoutinseconds // ModelDataDownloadTimeoutInSeconds *float64 `field:"optional" json:"modelDataDownloadTimeoutInSeconds" yaml:"modelDataDownloadTimeoutInSeconds"` }
Settings that take effect while the model container starts up.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceComponentStartupParametersProperty := &InferenceComponentStartupParametersProperty{ ContainerStartupHealthCheckTimeoutInSeconds: jsii.Number(123), ModelDataDownloadTimeoutInSeconds: jsii.Number(123), }
type CfnInferenceExperiment ¶ added in v2.70.0
type CfnInferenceExperiment interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN for your inference experiment. AttrArn() *string // The timestamp at which the inference experiment was created. AttrCreationTime() *string // The metadata of the endpoint on which the inference experiment ran. AttrEndpointMetadata() awscdk.IResolvable AttrEndpointMetadataEndpointConfigName() *string AttrEndpointMetadataEndpointName() *string AttrEndpointMetadataEndpointStatus() *string // The timestamp at which you last modified the inference experiment. AttrLastModifiedTime() *string // The status of the inference experiment. The following are the possible statuses for an inference experiment:. // // - `Creating` - Amazon SageMaker is creating your experiment. // - `Created` - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time. // - `Updating` - When you make changes to your experiment, your experiment shows as updating. // - `Starting` - Amazon SageMaker is beginning your experiment. // - `Running` - Your experiment is in progress. // - `Stopping` - Amazon SageMaker is stopping your experiment. // - `Completed` - Your experiment has completed. // - `Cancelled` - When you conclude your experiment early using the [StopInferenceExperiment](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) API, or if any operation fails with an unexpected error, it shows as cancelled. AttrStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Amazon S3 location and configuration for storing inference request and response data. DataStorageConfig() interface{} SetDataStorageConfig(val interface{}) // The description of the inference experiment. Description() *string SetDescription(val *string) // The desired state of the experiment after stopping. // // The possible states are the following:. DesiredState() *string SetDesiredState(val *string) // The name of the endpoint. EndpointName() *string SetEndpointName(val *string) // The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. KmsKey() *string SetKmsKey(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // An array of `ModelVariantConfigSummary` objects. ModelVariants() interface{} SetModelVariants(val interface{}) // The name of the inference experiment. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. RoleArn() *string SetRoleArn(val *string) // The duration for which the inference experiment ran or will run. Schedule() interface{} SetSchedule(val interface{}) // The configuration of `ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. ShadowModeConfig() interface{} SetShadowModeConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The error message for the inference experiment status result. StatusReason() *string SetStatusReason(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The type of the inference experiment. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates an inference experiment using the configurations specified in the request.
Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see [Shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html) .
Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.
While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see [View, monitor, and edit shadow tests](https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInferenceExperiment := awscdk.Aws_sagemaker.NewCfnInferenceExperiment(this, jsii.String("MyCfnInferenceExperiment"), &CfnInferenceExperimentProps{ EndpointName: jsii.String("endpointName"), ModelVariants: []interface{}{ &ModelVariantConfigProperty{ InfrastructureConfig: &ModelInfrastructureConfigProperty{ InfrastructureType: jsii.String("infrastructureType"), RealTimeInferenceConfig: &RealTimeInferenceConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), }, }, ModelName: jsii.String("modelName"), VariantName: jsii.String("variantName"), }, }, Name: jsii.String("name"), RoleArn: jsii.String("roleArn"), Type: jsii.String("type"), // the properties below are optional DataStorageConfig: &DataStorageConfigProperty{ Destination: jsii.String("destination"), // the properties below are optional ContentType: &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }, KmsKey: jsii.String("kmsKey"), }, Description: jsii.String("description"), DesiredState: jsii.String("desiredState"), KmsKey: jsii.String("kmsKey"), Schedule: &InferenceExperimentScheduleProperty{ EndTime: jsii.String("endTime"), StartTime: jsii.String("startTime"), }, ShadowModeConfig: &ShadowModeConfigProperty{ ShadowModelVariants: []interface{}{ &ShadowModelVariantConfigProperty{ SamplingPercentage: jsii.Number(123), ShadowModelVariantName: jsii.String("shadowModelVariantName"), }, }, SourceModelVariantName: jsii.String("sourceModelVariantName"), }, StatusReason: jsii.String("statusReason"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnInferenceExperiment ¶ added in v2.70.0
func NewCfnInferenceExperiment(scope constructs.Construct, id *string, props *CfnInferenceExperimentProps) CfnInferenceExperiment
type CfnInferenceExperimentProps ¶ added in v2.70.0
type CfnInferenceExperimentProps struct { // The name of the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // An array of `ModelVariantConfigSummary` objects. // // There is one for each variant in the inference experiment. Each `ModelVariantConfigSummary` object in the array describes the infrastructure configuration for deploying the corresponding variant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-modelvariants // ModelVariants interface{} `field:"required" json:"modelVariants" yaml:"modelVariants"` // The name of the inference experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-name // Name *string `field:"required" json:"name" yaml:"name"` // The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The type of the inference experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-type // Type *string `field:"required" json:"type" yaml:"type"` // The Amazon S3 location and configuration for storing inference request and response data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-datastorageconfig // DataStorageConfig interface{} `field:"optional" json:"dataStorageConfig" yaml:"dataStorageConfig"` // The description of the inference experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-description // Description *string `field:"optional" json:"description" yaml:"description"` // The desired state of the experiment after stopping. The possible states are the following:. // // - `Completed` : The experiment completed successfully // - `Cancelled` : The experiment was canceled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-desiredstate // DesiredState *string `field:"optional" json:"desiredState" yaml:"desiredState"` // The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-kmskey // KmsKey *string `field:"optional" json:"kmsKey" yaml:"kmsKey"` // The duration for which the inference experiment ran or will run. // // The maximum duration that you can set for an inference experiment is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-schedule // Schedule interface{} `field:"optional" json:"schedule" yaml:"schedule"` // The configuration of `ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. // // For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig // ShadowModeConfig interface{} `field:"optional" json:"shadowModeConfig" yaml:"shadowModeConfig"` // The error message for the inference experiment status result. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-statusreason // StatusReason *string `field:"optional" json:"statusReason" yaml:"statusReason"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferenceexperiment.html#cfn-sagemaker-inferenceexperiment-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnInferenceExperiment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInferenceExperimentProps := &CfnInferenceExperimentProps{ EndpointName: jsii.String("endpointName"), ModelVariants: []interface{}{ &ModelVariantConfigProperty{ InfrastructureConfig: &ModelInfrastructureConfigProperty{ InfrastructureType: jsii.String("infrastructureType"), RealTimeInferenceConfig: &RealTimeInferenceConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), }, }, ModelName: jsii.String("modelName"), VariantName: jsii.String("variantName"), }, }, Name: jsii.String("name"), RoleArn: jsii.String("roleArn"), Type: jsii.String("type"), // the properties below are optional DataStorageConfig: &DataStorageConfigProperty{ Destination: jsii.String("destination"), // the properties below are optional ContentType: &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }, KmsKey: jsii.String("kmsKey"), }, Description: jsii.String("description"), DesiredState: jsii.String("desiredState"), KmsKey: jsii.String("kmsKey"), Schedule: &InferenceExperimentScheduleProperty{ EndTime: jsii.String("endTime"), StartTime: jsii.String("startTime"), }, ShadowModeConfig: &ShadowModeConfigProperty{ ShadowModelVariants: []interface{}{ &ShadowModelVariantConfigProperty{ SamplingPercentage: jsii.Number(123), ShadowModelVariantName: jsii.String("shadowModelVariantName"), }, }, SourceModelVariantName: jsii.String("sourceModelVariantName"), }, StatusReason: jsii.String("statusReason"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnInferenceExperiment_CaptureContentTypeHeaderProperty ¶ added in v2.70.0
type CfnInferenceExperiment_CaptureContentTypeHeaderProperty struct { // The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html#cfn-sagemaker-inferenceexperiment-capturecontenttypeheader-csvcontenttypes // CsvContentTypes *[]*string `field:"optional" json:"csvContentTypes" yaml:"csvContentTypes"` // The list of all content type headers that SageMaker will treat as JSON and capture accordingly. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-capturecontenttypeheader.html#cfn-sagemaker-inferenceexperiment-capturecontenttypeheader-jsoncontenttypes // JsonContentTypes *[]*string `field:"optional" json:"jsonContentTypes" yaml:"jsonContentTypes"` }
Configuration specifying how to treat different headers.
If no headers are specified Amazon SageMaker will by default base64 encode when capturing the data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" captureContentTypeHeaderProperty := &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }
type CfnInferenceExperiment_DataStorageConfigProperty ¶ added in v2.70.0
type CfnInferenceExperiment_DataStorageConfigProperty struct { // The Amazon S3 bucket where the inference request and response data is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-destination // Destination *string `field:"required" json:"destination" yaml:"destination"` // Configuration specifying how to treat different headers. // // If no headers are specified SageMaker will by default base64 encode when capturing the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-contenttype // ContentType interface{} `field:"optional" json:"contentType" yaml:"contentType"` // The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-datastorageconfig.html#cfn-sagemaker-inferenceexperiment-datastorageconfig-kmskey // KmsKey *string `field:"optional" json:"kmsKey" yaml:"kmsKey"` }
The Amazon S3 location and configuration for storing inference request and response data.
This is an optional parameter that you can use for data capture. For more information, see [Capture data](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataStorageConfigProperty := &DataStorageConfigProperty{ Destination: jsii.String("destination"), // the properties below are optional ContentType: &CaptureContentTypeHeaderProperty{ CsvContentTypes: []*string{ jsii.String("csvContentTypes"), }, JsonContentTypes: []*string{ jsii.String("jsonContentTypes"), }, }, KmsKey: jsii.String("kmsKey"), }
type CfnInferenceExperiment_EndpointMetadataProperty ¶ added in v2.70.0
type CfnInferenceExperiment_EndpointMetadataProperty struct { // The name of the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // The name of the endpoint configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointconfigname // EndpointConfigName *string `field:"optional" json:"endpointConfigName" yaml:"endpointConfigName"` // The status of the endpoint. // // For possible values of the status of an endpoint, see [](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointstatus) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-endpointmetadata.html#cfn-sagemaker-inferenceexperiment-endpointmetadata-endpointstatus // EndpointStatus *string `field:"optional" json:"endpointStatus" yaml:"endpointStatus"` }
The metadata of the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointMetadataProperty := &EndpointMetadataProperty{ EndpointName: jsii.String("endpointName"), // the properties below are optional EndpointConfigName: jsii.String("endpointConfigName"), EndpointStatus: jsii.String("endpointStatus"), }
type CfnInferenceExperiment_InferenceExperimentScheduleProperty ¶ added in v2.70.0
type CfnInferenceExperiment_InferenceExperimentScheduleProperty struct { // The timestamp at which the inference experiment ended or will end. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html#cfn-sagemaker-inferenceexperiment-inferenceexperimentschedule-endtime // EndTime *string `field:"optional" json:"endTime" yaml:"endTime"` // The timestamp at which the inference experiment started or will start. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-inferenceexperimentschedule.html#cfn-sagemaker-inferenceexperiment-inferenceexperimentschedule-starttime // StartTime *string `field:"optional" json:"startTime" yaml:"startTime"` }
The start and end times of an inference experiment.
The maximum duration that you can set for an inference experiment is 30 days.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceExperimentScheduleProperty := &InferenceExperimentScheduleProperty{ EndTime: jsii.String("endTime"), StartTime: jsii.String("startTime"), }
type CfnInferenceExperiment_ModelInfrastructureConfigProperty ¶ added in v2.70.0
type CfnInferenceExperiment_ModelInfrastructureConfigProperty struct { // The inference option to which to deploy your model. Possible values are the following:. // // - `RealTime` : Deploy to real-time inference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html#cfn-sagemaker-inferenceexperiment-modelinfrastructureconfig-infrastructuretype // InfrastructureType *string `field:"required" json:"infrastructureType" yaml:"infrastructureType"` // The infrastructure configuration for deploying the model to real-time inference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelinfrastructureconfig.html#cfn-sagemaker-inferenceexperiment-modelinfrastructureconfig-realtimeinferenceconfig // RealTimeInferenceConfig interface{} `field:"required" json:"realTimeInferenceConfig" yaml:"realTimeInferenceConfig"` }
The configuration for the infrastructure that the model will be deployed to.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelInfrastructureConfigProperty := &ModelInfrastructureConfigProperty{ InfrastructureType: jsii.String("infrastructureType"), RealTimeInferenceConfig: &RealTimeInferenceConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), }, }
type CfnInferenceExperiment_ModelVariantConfigProperty ¶ added in v2.70.0
type CfnInferenceExperiment_ModelVariantConfigProperty struct { // The configuration for the infrastructure that the model will be deployed to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-infrastructureconfig // InfrastructureConfig interface{} `field:"required" json:"infrastructureConfig" yaml:"infrastructureConfig"` // The name of the Amazon SageMaker Model entity. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-modelname // ModelName *string `field:"required" json:"modelName" yaml:"modelName"` // The name of the variant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-modelvariantconfig.html#cfn-sagemaker-inferenceexperiment-modelvariantconfig-variantname // VariantName *string `field:"required" json:"variantName" yaml:"variantName"` }
Contains information about the deployment options of a model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelVariantConfigProperty := &ModelVariantConfigProperty{ InfrastructureConfig: &ModelInfrastructureConfigProperty{ InfrastructureType: jsii.String("infrastructureType"), RealTimeInferenceConfig: &RealTimeInferenceConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), }, }, ModelName: jsii.String("modelName"), VariantName: jsii.String("variantName"), }
type CfnInferenceExperiment_RealTimeInferenceConfigProperty ¶ added in v2.70.0
type CfnInferenceExperiment_RealTimeInferenceConfigProperty struct { // The number of instances of the type specified by `InstanceType` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html#cfn-sagemaker-inferenceexperiment-realtimeinferenceconfig-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The instance type the model is deployed to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-realtimeinferenceconfig.html#cfn-sagemaker-inferenceexperiment-realtimeinferenceconfig-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` }
The infrastructure configuration for deploying the model to a real-time inference endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" realTimeInferenceConfigProperty := &RealTimeInferenceConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), }
type CfnInferenceExperiment_ShadowModeConfigProperty ¶ added in v2.70.0
type CfnInferenceExperiment_ShadowModeConfigProperty struct { // List of shadow variant configurations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig-shadowmodelvariants // ShadowModelVariants interface{} `field:"required" json:"shadowModelVariants" yaml:"shadowModelVariants"` // The name of the production variant, which takes all the inference requests. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodeconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodeconfig-sourcemodelvariantname // SourceModelVariantName *string `field:"required" json:"sourceModelVariantName" yaml:"sourceModelVariantName"` }
The configuration of `ShadowMode` inference experiment type, which specifies a production variant to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.
For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" shadowModeConfigProperty := &ShadowModeConfigProperty{ ShadowModelVariants: []interface{}{ &ShadowModelVariantConfigProperty{ SamplingPercentage: jsii.Number(123), ShadowModelVariantName: jsii.String("shadowModelVariantName"), }, }, SourceModelVariantName: jsii.String("sourceModelVariantName"), }
type CfnInferenceExperiment_ShadowModelVariantConfigProperty ¶ added in v2.70.0
type CfnInferenceExperiment_ShadowModelVariantConfigProperty struct { // The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodelvariantconfig-samplingpercentage // SamplingPercentage *float64 `field:"required" json:"samplingPercentage" yaml:"samplingPercentage"` // The name of the shadow variant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferenceexperiment-shadowmodelvariantconfig.html#cfn-sagemaker-inferenceexperiment-shadowmodelvariantconfig-shadowmodelvariantname // ShadowModelVariantName *string `field:"required" json:"shadowModelVariantName" yaml:"shadowModelVariantName"` }
The name and sampling percentage of a shadow variant.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" shadowModelVariantConfigProperty := &ShadowModelVariantConfigProperty{ SamplingPercentage: jsii.Number(123), ShadowModelVariantName: jsii.String("shadowModelVariantName"), }
type CfnMlflowTrackingServer ¶ added in v2.154.0
type CfnMlflowTrackingServer interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon S3 URI for MLFlow Tracking Server artifacts. ArtifactStoreUri() *string SetArtifactStoreUri(val *string) // The Amazon Resource Name (ARN) of the MLFlow Tracking Server. AttrTrackingServerArn() *string // A flag to enable Automatic SageMaker Model Registration. AutomaticModelRegistration() interface{} SetAutomaticModelRegistration(val interface{}) // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The MLFlow Version used on the MLFlow Tracking Server. MlflowVersion() *string SetMlflowVersion(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An array of key-value pairs to apply to this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // The name of the MLFlow Tracking Server. TrackingServerName() *string SetTrackingServerName(val *string) // The size of the MLFlow Tracking Server. TrackingServerSize() *string SetTrackingServerSize(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The start of the time window for maintenance of the MLFlow Tracking Server in UTC time. WeeklyMaintenanceWindowStart() *string SetWeeklyMaintenanceWindowStart(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.
For more information, see [Create an MLflow Tracking Server](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMlflowTrackingServer := awscdk.Aws_sagemaker.NewCfnMlflowTrackingServer(this, jsii.String("MyCfnMlflowTrackingServer"), &CfnMlflowTrackingServerProps{ ArtifactStoreUri: jsii.String("artifactStoreUri"), RoleArn: jsii.String("roleArn"), TrackingServerName: jsii.String("trackingServerName"), // the properties below are optional AutomaticModelRegistration: jsii.Boolean(false), MlflowVersion: jsii.String("mlflowVersion"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TrackingServerSize: jsii.String("trackingServerSize"), WeeklyMaintenanceWindowStart: jsii.String("weeklyMaintenanceWindowStart"), })
func NewCfnMlflowTrackingServer ¶ added in v2.154.0
func NewCfnMlflowTrackingServer(scope constructs.Construct, id *string, props *CfnMlflowTrackingServerProps) CfnMlflowTrackingServer
type CfnMlflowTrackingServerProps ¶ added in v2.154.0
type CfnMlflowTrackingServerProps struct { // The Amazon S3 URI for MLFlow Tracking Server artifacts. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-artifactstoreuri // ArtifactStoreUri *string `field:"required" json:"artifactStoreUri" yaml:"artifactStoreUri"` // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the MLFlow Tracking Server. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-trackingservername // TrackingServerName *string `field:"required" json:"trackingServerName" yaml:"trackingServerName"` // A flag to enable Automatic SageMaker Model Registration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-automaticmodelregistration // AutomaticModelRegistration interface{} `field:"optional" json:"automaticModelRegistration" yaml:"automaticModelRegistration"` // The MLFlow Version used on the MLFlow Tracking Server. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-mlflowversion // MlflowVersion *string `field:"optional" json:"mlflowVersion" yaml:"mlflowVersion"` // An array of key-value pairs to apply to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The size of the MLFlow Tracking Server. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-trackingserversize // TrackingServerSize *string `field:"optional" json:"trackingServerSize" yaml:"trackingServerSize"` // The start of the time window for maintenance of the MLFlow Tracking Server in UTC time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-mlflowtrackingserver.html#cfn-sagemaker-mlflowtrackingserver-weeklymaintenancewindowstart // WeeklyMaintenanceWindowStart *string `field:"optional" json:"weeklyMaintenanceWindowStart" yaml:"weeklyMaintenanceWindowStart"` }
Properties for defining a `CfnMlflowTrackingServer`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMlflowTrackingServerProps := &CfnMlflowTrackingServerProps{ ArtifactStoreUri: jsii.String("artifactStoreUri"), RoleArn: jsii.String("roleArn"), TrackingServerName: jsii.String("trackingServerName"), // the properties below are optional AutomaticModelRegistration: jsii.Boolean(false), MlflowVersion: jsii.String("mlflowVersion"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TrackingServerSize: jsii.String("trackingServerSize"), WeeklyMaintenanceWindowStart: jsii.String("weeklyMaintenanceWindowStart"), }
type CfnModel ¶
type CfnModel interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // The name of the model, such as `MyModel` . AttrModelName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Specifies the containers in the inference pipeline. Containers() interface{} SetContainers(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Isolates the model container. EnableNetworkIsolation() interface{} SetEnableNetworkIsolation(val interface{}) // The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. ExecutionRoleArn() *string SetExecutionRoleArn(val *string) // Specifies details of how containers in a multi-container endpoint are called. InferenceExecutionConfig() interface{} SetInferenceExecutionConfig(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the new model. ModelName() *string SetModelName(val *string) // The tree node. Node() constructs.Node // 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{} SetPrimaryContainer(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // 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{} SetVpcConfig(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var environment interface{} cfnModel := awscdk.Aws_sagemaker.NewCfnModel(this, jsii.String("MyCfnModel"), &CfnModelProps{ Containers: []interface{}{ &ContainerDefinitionProperty{ ContainerHostname: jsii.String("containerHostname"), Environment: environment, Image: jsii.String("image"), ImageConfig: &ImageConfigProperty{ RepositoryAccessMode: jsii.String("repositoryAccessMode"), // the properties below are optional RepositoryAuthConfig: &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }, }, InferenceSpecificationName: jsii.String("inferenceSpecificationName"), Mode: jsii.String("mode"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelPackageName: jsii.String("modelPackageName"), MultiModelConfig: &MultiModelConfigProperty{ ModelCacheSetting: jsii.String("modelCacheSetting"), }, }, }, EnableNetworkIsolation: jsii.Boolean(false), ExecutionRoleArn: jsii.String("executionRoleArn"), InferenceExecutionConfig: &InferenceExecutionConfigProperty{ Mode: jsii.String("mode"), }, ModelName: jsii.String("modelName"), PrimaryContainer: &ContainerDefinitionProperty{ ContainerHostname: jsii.String("containerHostname"), Environment: environment, Image: jsii.String("image"), ImageConfig: &ImageConfigProperty{ RepositoryAccessMode: jsii.String("repositoryAccessMode"), // the properties below are optional RepositoryAuthConfig: &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }, }, InferenceSpecificationName: jsii.String("inferenceSpecificationName"), Mode: jsii.String("mode"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelPackageName: jsii.String("modelPackageName"), MultiModelConfig: &MultiModelConfigProperty{ ModelCacheSetting: jsii.String("modelCacheSetting"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html
func NewCfnModel ¶
func NewCfnModel(scope constructs.Construct, id *string, props *CfnModelProps) CfnModel
type CfnModelBiasJobDefinition ¶
type CfnModelBiasJobDefinition interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time when the job definition was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the job definition. AttrJobDefinitionArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the endpoint used to run the monitoring job. EndpointName() *string SetEndpointName(val *string) // The name of the bias job definition. JobDefinitionName() *string SetJobDefinitionName(val *string) // Identifies the resources to deploy for a monitoring job. JobResources() interface{} SetJobResources(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Configures the model bias job to run a specified Docker container image. ModelBiasAppSpecification() interface{} SetModelBiasAppSpecification(val interface{}) // The baseline configuration for a model bias job. ModelBiasBaselineConfig() interface{} SetModelBiasBaselineConfig(val interface{}) // Inputs for the model bias job. ModelBiasJobInput() interface{} SetModelBiasJobInput(val interface{}) // The output configuration for monitoring jobs. ModelBiasJobOutputConfig() interface{} SetModelBiasJobOutputConfig(val interface{}) // Networking options for a model bias job. NetworkConfig() interface{} SetNetworkConfig(val interface{}) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A time limit for how long the monitoring job is allowed to run before stopping. StoppingCondition() interface{} SetStoppingCondition(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates the definition for a model bias job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnModelBiasJobDefinition := awscdk.Aws_sagemaker.NewCfnModelBiasJobDefinition(this, jsii.String("MyCfnModelBiasJobDefinition"), &CfnModelBiasJobDefinitionProps{ JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, ModelBiasAppSpecification: &ModelBiasAppSpecificationProperty{ ConfigUri: jsii.String("configUri"), ImageUri: jsii.String("imageUri"), // the properties below are optional Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, }, ModelBiasJobInput: &ModelBiasJobInputProperty{ GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }, // the properties below are optional BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, }, ModelBiasJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), ModelBiasBaselineConfig: &ModelBiasBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnModelBiasJobDefinition ¶
func NewCfnModelBiasJobDefinition(scope constructs.Construct, id *string, props *CfnModelBiasJobDefinitionProps) CfnModelBiasJobDefinition
type CfnModelBiasJobDefinitionProps ¶
type CfnModelBiasJobDefinitionProps struct { // Identifies the resources to deploy for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-jobresources // JobResources interface{} `field:"required" json:"jobResources" yaml:"jobResources"` // Configures the model bias job to run a specified Docker container image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasappspecification // ModelBiasAppSpecification interface{} `field:"required" json:"modelBiasAppSpecification" yaml:"modelBiasAppSpecification"` // Inputs for the model bias job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjobinput // ModelBiasJobInput interface{} `field:"required" json:"modelBiasJobInput" yaml:"modelBiasJobInput"` // The output configuration for monitoring jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjoboutputconfig // ModelBiasJobOutputConfig interface{} `field:"required" json:"modelBiasJobOutputConfig" yaml:"modelBiasJobOutputConfig"` // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the endpoint used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // The name of the bias job definition. // // The name must be unique within an AWS Region in the AWS account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-jobdefinitionname // JobDefinitionName *string `field:"optional" json:"jobDefinitionName" yaml:"jobDefinitionName"` // The baseline configuration for a model bias job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig // ModelBiasBaselineConfig interface{} `field:"optional" json:"modelBiasBaselineConfig" yaml:"modelBiasBaselineConfig"` // Networking options for a model bias job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-networkconfig // NetworkConfig interface{} `field:"optional" json:"networkConfig" yaml:"networkConfig"` // A time limit for how long the monitoring job is allowed to run before stopping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-stoppingcondition // StoppingCondition interface{} `field:"optional" json:"stoppingCondition" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnModelBiasJobDefinition`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnModelBiasJobDefinitionProps := &CfnModelBiasJobDefinitionProps{ JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, ModelBiasAppSpecification: &ModelBiasAppSpecificationProperty{ ConfigUri: jsii.String("configUri"), ImageUri: jsii.String("imageUri"), // the properties below are optional Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, }, ModelBiasJobInput: &ModelBiasJobInputProperty{ GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }, // the properties below are optional BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, }, ModelBiasJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), ModelBiasBaselineConfig: &ModelBiasBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnModelBiasJobDefinition_BatchTransformInputProperty ¶ added in v2.48.0
type CfnModelBiasJobDefinition_BatchTransformInputProperty struct { // The Amazon S3 location being used to capture the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-datacaptureddestinations3uri // DataCapturedDestinationS3Uri *string `field:"required" json:"dataCapturedDestinationS3Uri" yaml:"dataCapturedDestinationS3Uri"` // The dataset format for your batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-datasetformat // DatasetFormat interface{} `field:"required" json:"datasetFormat" yaml:"datasetFormat"` // Path to the filesystem where the batch transform data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // If specified, monitoring jobs subtract 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-endtimeoffset // EndTimeOffset *string `field:"optional" json:"endTimeOffset" yaml:"endTimeOffset"` // The attributes of the input data that are the input features. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-featuresattribute // FeaturesAttribute *string `field:"optional" json:"featuresAttribute" yaml:"featuresAttribute"` // The attribute of the input data that represents the ground truth label. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-inferenceattribute // InferenceAttribute *string `field:"optional" json:"inferenceAttribute" yaml:"inferenceAttribute"` // In a classification problem, the attribute that represents the class probability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // The threshold for the class probability to be evaluated as a positive result. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-probabilitythresholdattribute // ProbabilityThresholdAttribute *float64 `field:"optional" json:"probabilityThresholdAttribute" yaml:"probabilityThresholdAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html#cfn-sagemaker-modelbiasjobdefinition-batchtransforminput-starttimeoffset // StartTimeOffset *string `field:"optional" json:"startTimeOffset" yaml:"startTimeOffset"` }
Input object for the batch transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" batchTransformInputProperty := &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }
type CfnModelBiasJobDefinition_ClusterConfigProperty ¶
type CfnModelBiasJobDefinition_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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-clusterconfig.html#cfn-sagemaker-modelbiasjobdefinition-clusterconfig-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The ML compute instance type for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-clusterconfig.html#cfn-sagemaker-modelbiasjobdefinition-clusterconfig-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The size of the ML storage volume, in gigabytes, that you want to provision. // // You must specify sufficient ML storage for your scenario. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-clusterconfig.html#cfn-sagemaker-modelbiasjobdefinition-clusterconfig-volumesizeingb // VolumeSizeInGb *float64 `field:"required" json:"volumeSizeInGb" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-clusterconfig.html#cfn-sagemaker-modelbiasjobdefinition-clusterconfig-volumekmskeyid // VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"` }
The configuration for the cluster resources used to run the processing job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterConfigProperty := &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }
type CfnModelBiasJobDefinition_ConstraintsResourceProperty ¶
type CfnModelBiasJobDefinition_ConstraintsResourceProperty struct { // The Amazon S3 URI for the constraints resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-constraintsresource.html#cfn-sagemaker-modelbiasjobdefinition-constraintsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
The constraints resource for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" constraintsResourceProperty := &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnModelBiasJobDefinition_CsvProperty ¶ added in v2.48.0
type CfnModelBiasJobDefinition_CsvProperty struct { // A boolean flag indicating if given CSV has header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-csv.html#cfn-sagemaker-modelbiasjobdefinition-csv-header // Header interface{} `field:"optional" json:"header" yaml:"header"` }
The CSV format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvProperty := &CsvProperty{ Header: jsii.Boolean(false), }
type CfnModelBiasJobDefinition_DatasetFormatProperty ¶ added in v2.48.0
type CfnModelBiasJobDefinition_DatasetFormatProperty struct { // The CSV format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-datasetformat.html#cfn-sagemaker-modelbiasjobdefinition-datasetformat-csv // Csv interface{} `field:"optional" json:"csv" yaml:"csv"` // The Json format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-datasetformat.html#cfn-sagemaker-modelbiasjobdefinition-datasetformat-json // Json interface{} `field:"optional" json:"json" yaml:"json"` // A flag indicate if the dataset format is Parquet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-datasetformat.html#cfn-sagemaker-modelbiasjobdefinition-datasetformat-parquet // Parquet interface{} `field:"optional" json:"parquet" yaml:"parquet"` }
The dataset format of the data to monitor.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetFormatProperty := &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }
type CfnModelBiasJobDefinition_EndpointInputProperty ¶
type CfnModelBiasJobDefinition_EndpointInputProperty struct { // An endpoint in customer's account which has enabled `DataCaptureConfig` enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // Path to the filesystem where the endpoint data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-endtimeoffset // EndTimeOffset *string `field:"optional" json:"endTimeOffset" yaml:"endTimeOffset"` // The attributes of the input data that are the input features. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-featuresattribute // FeaturesAttribute *string `field:"optional" json:"featuresAttribute" yaml:"featuresAttribute"` // The attribute of the input data that represents the ground truth label. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-inferenceattribute // InferenceAttribute *string `field:"optional" json:"inferenceAttribute" yaml:"inferenceAttribute"` // In a classification problem, the attribute that represents the class probability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // The threshold for the class probability to be evaluated as a positive result. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-probabilitythresholdattribute // ProbabilityThresholdAttribute *float64 `field:"optional" json:"probabilityThresholdAttribute" yaml:"probabilityThresholdAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html#cfn-sagemaker-modelbiasjobdefinition-endpointinput-starttimeoffset // StartTimeOffset *string `field:"optional" json:"startTimeOffset" yaml:"startTimeOffset"` }
Input object for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointInputProperty := &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }
type CfnModelBiasJobDefinition_JsonProperty ¶ added in v2.48.0
type CfnModelBiasJobDefinition_JsonProperty struct { // A boolean flag indicating if it is JSON line format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-json.html#cfn-sagemaker-modelbiasjobdefinition-json-line // Line interface{} `field:"optional" json:"line" yaml:"line"` }
The Json format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jsonProperty := &JsonProperty{ Line: jsii.Boolean(false), }
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/dg/clarify-config-json-monitor-bias-parameters.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasappspecification.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasappspecification-configuri // ConfigUri *string `field:"required" json:"configUri" yaml:"configUri"` // The container image to be run by the model bias job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasappspecification.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasappspecification-imageuri // ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"` // Sets the environment variables in the Docker container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasappspecification.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasappspecification-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` }
Docker container image configuration object for the model bias job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelBiasAppSpecificationProperty := &ModelBiasAppSpecificationProperty{ ConfigUri: jsii.String("configUri"), ImageUri: jsii.String("imageUri"), // the properties below are optional Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, }
type CfnModelBiasJobDefinition_ModelBiasBaselineConfigProperty ¶
type CfnModelBiasJobDefinition_ModelBiasBaselineConfigProperty struct { // The name of the baseline model bias job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig-baseliningjobname // BaseliningJobName *string `field:"optional" json:"baseliningJobName" yaml:"baseliningJobName"` // The constraints resource for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasbaselineconfig-constraintsresource // ConstraintsResource interface{} `field:"optional" json:"constraintsResource" yaml:"constraintsResource"` }
The configuration for a baseline model bias job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelBiasBaselineConfigProperty := &ModelBiasBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }
type CfnModelBiasJobDefinition_ModelBiasJobInputProperty ¶
type CfnModelBiasJobDefinition_ModelBiasJobInputProperty struct { // Location of ground truth labels to use in model bias job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasjobinput.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjobinput-groundtruths3input // GroundTruthS3Input interface{} `field:"required" json:"groundTruthS3Input" yaml:"groundTruthS3Input"` // Input object for the batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasjobinput.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjobinput-batchtransforminput // BatchTransformInput interface{} `field:"optional" json:"batchTransformInput" yaml:"batchTransformInput"` // Input object for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-modelbiasjobinput.html#cfn-sagemaker-modelbiasjobdefinition-modelbiasjobinput-endpointinput // EndpointInput interface{} `field:"optional" json:"endpointInput" yaml:"endpointInput"` }
Inputs for the model bias job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelBiasJobInputProperty := &ModelBiasJobInputProperty{ GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }, // the properties below are optional BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, }
type CfnModelBiasJobDefinition_MonitoringGroundTruthS3InputProperty ¶
type CfnModelBiasJobDefinition_MonitoringGroundTruthS3InputProperty struct { // The address of the Amazon S3 location of the ground truth labels. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-monitoringgroundtruths3input.html#cfn-sagemaker-modelbiasjobdefinition-monitoringgroundtruths3input-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` }
The ground truth labels for the dataset used for the monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringGroundTruthS3InputProperty := &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnModelBiasJobDefinition_MonitoringOutputConfigProperty ¶
type CfnModelBiasJobDefinition_MonitoringOutputConfigProperty struct { // Monitoring outputs for monitoring jobs. // // This is where the output of the periodic monitoring jobs is uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-modelbiasjobdefinition-monitoringoutputconfig-monitoringoutputs // MonitoringOutputs interface{} `field:"required" json:"monitoringOutputs" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-modelbiasjobdefinition-monitoringoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The output configuration for monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputConfigProperty := &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnModelBiasJobDefinition_MonitoringOutputProperty ¶
type CfnModelBiasJobDefinition_MonitoringOutputProperty struct { // The Amazon S3 storage location where the results of a monitoring job are saved. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-monitoringoutput.html#cfn-sagemaker-modelbiasjobdefinition-monitoringoutput-s3output // S3Output interface{} `field:"required" json:"s3Output" yaml:"s3Output"` }
The output object for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputProperty := &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }
type CfnModelBiasJobDefinition_MonitoringResourcesProperty ¶
type CfnModelBiasJobDefinition_MonitoringResourcesProperty struct { // The configuration for the cluster resources used to run the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-monitoringresources.html#cfn-sagemaker-modelbiasjobdefinition-monitoringresources-clusterconfig // ClusterConfig interface{} `field:"required" json:"clusterConfig" yaml:"clusterConfig"` }
Identifies the resources to deploy for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringResourcesProperty := &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-networkconfig.html#cfn-sagemaker-modelbiasjobdefinition-networkconfig-enableintercontainertrafficencryption // EnableInterContainerTrafficEncryption interface{} `field:"optional" json:"enableInterContainerTrafficEncryption" yaml:"enableInterContainerTrafficEncryption"` // Whether to allow inbound and outbound network calls to and from the containers used for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-networkconfig.html#cfn-sagemaker-modelbiasjobdefinition-networkconfig-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-networkconfig.html#cfn-sagemaker-modelbiasjobdefinition-networkconfig-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" networkConfigProperty := &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-s3output.html#cfn-sagemaker-modelbiasjobdefinition-s3output-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-s3output.html#cfn-sagemaker-modelbiasjobdefinition-s3output-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // Whether to upload the results of the monitoring job continuously or after the job completes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-s3output.html#cfn-sagemaker-modelbiasjobdefinition-s3output-s3uploadmode // S3UploadMode *string `field:"optional" json:"s3UploadMode" yaml:"s3UploadMode"` }
The Amazon S3 storage location where the results of a monitoring job are saved.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3OutputProperty := &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }
type CfnModelBiasJobDefinition_StoppingConditionProperty ¶
type CfnModelBiasJobDefinition_StoppingConditionProperty struct { // The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. // // For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model. // // For all other jobs, if the job does not complete during this time, 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. // // The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-stoppingcondition.html#cfn-sagemaker-modelbiasjobdefinition-stoppingcondition-maxruntimeinseconds // MaxRuntimeInSeconds *float64 `field:"required" json:"maxRuntimeInSeconds" yaml:"maxRuntimeInSeconds"` }
Specifies a limit to how long a job can run.
When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, 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 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stoppingConditionProperty := &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-vpcconfig.html#cfn-sagemaker-modelbiasjobdefinition-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-vpcconfig.html#cfn-sagemaker-modelbiasjobdefinition-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
type CfnModelCard ¶ added in v2.64.0
type CfnModelCard interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The domain associated with the user. AttrCreatedByDomainId() *string // The Amazon Resource Name (ARN) of the user's profile. AttrCreatedByUserProfileArn() *string // The name of the user's profile. AttrCreatedByUserProfileName() *string // The date and time the model card was created. AttrCreationTime() *string // The domain associated with the user. AttrLastModifiedByDomainId() *string // The Amazon Resource Name (ARN) of the user's profile. AttrLastModifiedByUserProfileArn() *string // The name of the user's profile. AttrLastModifiedByUserProfileName() *string // The date and time the model card was last modified. AttrLastModifiedTime() *string // The Amazon Resource Number (ARN) of the model card. // // For example, `arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard` . AttrModelCardArn() *string // The processing status of model card deletion. // // The ModelCardProcessingStatus updates throughout the different deletion steps. AttrModelCardProcessingStatus() *string // A version of the model card. AttrModelCardVersion() *float64 // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The content of the model card. Content() interface{} SetContent(val interface{}) // Information about the user who created or modified one or more of the following:. CreatedBy() interface{} SetCreatedBy(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. LastModifiedBy() interface{} SetLastModifiedBy(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The unique name of the model card. ModelCardName() *string SetModelCardName(val *string) // The approval status of the model card within your organization. ModelCardStatus() *string SetModelCardStatus(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The security configuration used to protect model card data. SecurityConfig() interface{} SetSecurityConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Key-value pairs used to manage metadata for the model card. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see [Amazon SageMaker Model Card](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var value interface{} cfnModelCard := awscdk.Aws_sagemaker.NewCfnModelCard(this, jsii.String("MyCfnModelCard"), &CfnModelCardProps{ Content: &ContentProperty{ AdditionalInformation: &AdditionalInformationProperty{ CaveatsAndRecommendations: jsii.String("caveatsAndRecommendations"), CustomDetails: map[string]*string{ "customDetailsKey": jsii.String("customDetails"), }, EthicalConsiderations: jsii.String("ethicalConsiderations"), }, BusinessDetails: &BusinessDetailsProperty{ BusinessProblem: jsii.String("businessProblem"), BusinessStakeholders: jsii.String("businessStakeholders"), LineOfBusiness: jsii.String("lineOfBusiness"), }, EvaluationDetails: []interface{}{ &EvaluationDetailProperty{ Name: jsii.String("name"), // the properties below are optional Datasets: []*string{ jsii.String("datasets"), }, EvaluationJobArn: jsii.String("evaluationJobArn"), EvaluationObservation: jsii.String("evaluationObservation"), Metadata: map[string]*string{ "metadataKey": jsii.String("metadata"), }, MetricGroups: []interface{}{ &MetricGroupProperty{ MetricData: []interface{}{ &MetricDataItemsProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Value: value, // the properties below are optional Notes: jsii.String("notes"), XAxisName: []*string{ jsii.String("xAxisName"), }, YAxisName: []*string{ jsii.String("yAxisName"), }, }, }, Name: jsii.String("name"), }, }, }, }, IntendedUses: &IntendedUsesProperty{ ExplanationsForRiskRating: jsii.String("explanationsForRiskRating"), FactorsAffectingModelEfficiency: jsii.String("factorsAffectingModelEfficiency"), IntendedUses: jsii.String("intendedUses"), PurposeOfModel: jsii.String("purposeOfModel"), RiskRating: jsii.String("riskRating"), }, ModelOverview: &ModelOverviewProperty{ AlgorithmType: jsii.String("algorithmType"), InferenceEnvironment: &InferenceEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, ModelArtifact: []*string{ jsii.String("modelArtifact"), }, ModelCreator: jsii.String("modelCreator"), ModelDescription: jsii.String("modelDescription"), ModelId: jsii.String("modelId"), ModelName: jsii.String("modelName"), ModelOwner: jsii.String("modelOwner"), ModelVersion: jsii.Number(123), ProblemType: jsii.String("problemType"), }, ModelPackageDetails: &ModelPackageDetailsProperty{ ApprovalDescription: jsii.String("approvalDescription"), CreatedBy: &ModelPackageCreatorProperty{ UserProfileName: jsii.String("userProfileName"), }, Domain: jsii.String("domain"), InferenceSpecification: &InferenceSpecificationProperty{ Containers: []interface{}{ &ContainerProperty{ Image: jsii.String("image"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), NearestModelName: jsii.String("nearestModelName"), }, }, }, ModelApprovalStatus: jsii.String("modelApprovalStatus"), ModelPackageArn: jsii.String("modelPackageArn"), ModelPackageDescription: jsii.String("modelPackageDescription"), ModelPackageGroupName: jsii.String("modelPackageGroupName"), ModelPackageName: jsii.String("modelPackageName"), ModelPackageStatus: jsii.String("modelPackageStatus"), ModelPackageVersion: jsii.Number(123), SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, Task: jsii.String("task"), }, TrainingDetails: &TrainingDetailsProperty{ ObjectiveFunction: &ObjectiveFunctionProperty{ Function: &FunctionProperty{ Condition: jsii.String("condition"), Facet: jsii.String("facet"), Function: jsii.String("function"), }, Notes: jsii.String("notes"), }, TrainingJobDetails: &TrainingJobDetailsProperty{ HyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, TrainingArn: jsii.String("trainingArn"), TrainingDatasets: []*string{ jsii.String("trainingDatasets"), }, TrainingEnvironment: &TrainingEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, TrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, UserProvidedHyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, UserProvidedTrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, }, TrainingObservations: jsii.String("trainingObservations"), }, }, ModelCardName: jsii.String("modelCardName"), ModelCardStatus: jsii.String("modelCardStatus"), // the properties below are optional CreatedBy: &UserContextProperty{ DomainId: jsii.String("domainId"), UserProfileArn: jsii.String("userProfileArn"), UserProfileName: jsii.String("userProfileName"), }, LastModifiedBy: &UserContextProperty{ DomainId: jsii.String("domainId"), UserProfileArn: jsii.String("userProfileArn"), UserProfileName: jsii.String("userProfileName"), }, SecurityConfig: &SecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html
func NewCfnModelCard ¶ added in v2.64.0
func NewCfnModelCard(scope constructs.Construct, id *string, props *CfnModelCardProps) CfnModelCard
type CfnModelCardProps ¶ added in v2.64.0
type CfnModelCardProps struct { // The content of the model card. // // Content uses the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-content // Content interface{} `field:"required" json:"content" yaml:"content"` // The unique name of the model card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardname // ModelCardName *string `field:"required" json:"modelCardName" yaml:"modelCardName"` // The approval status of the model card within your organization. // // Different organizations might have different criteria for model card review and approval. // // - `Draft` : The model card is a work in progress. // - `PendingReview` : The model card is pending review. // - `Approved` : The model card is approved. // - `Archived` : The model card is archived. No more updates should be made to the model card, but it can still be exported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardstatus // ModelCardStatus *string `field:"required" json:"modelCardStatus" yaml:"modelCardStatus"` // Information about the user who created or modified one or more of the following:. // // - Experiment // - Trial // - Trial component // - Lineage group // - Project // - Model Card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-createdby // CreatedBy interface{} `field:"optional" json:"createdBy" yaml:"createdBy"` // Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-lastmodifiedby // LastModifiedBy interface{} `field:"optional" json:"lastModifiedBy" yaml:"lastModifiedBy"` // The security configuration used to protect model card data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-securityconfig // SecurityConfig interface{} `field:"optional" json:"securityConfig" yaml:"securityConfig"` // Key-value pairs used to manage metadata for the model card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnModelCard`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var value interface{} cfnModelCardProps := &CfnModelCardProps{ Content: &ContentProperty{ AdditionalInformation: &AdditionalInformationProperty{ CaveatsAndRecommendations: jsii.String("caveatsAndRecommendations"), CustomDetails: map[string]*string{ "customDetailsKey": jsii.String("customDetails"), }, EthicalConsiderations: jsii.String("ethicalConsiderations"), }, BusinessDetails: &BusinessDetailsProperty{ BusinessProblem: jsii.String("businessProblem"), BusinessStakeholders: jsii.String("businessStakeholders"), LineOfBusiness: jsii.String("lineOfBusiness"), }, EvaluationDetails: []interface{}{ &EvaluationDetailProperty{ Name: jsii.String("name"), // the properties below are optional Datasets: []*string{ jsii.String("datasets"), }, EvaluationJobArn: jsii.String("evaluationJobArn"), EvaluationObservation: jsii.String("evaluationObservation"), Metadata: map[string]*string{ "metadataKey": jsii.String("metadata"), }, MetricGroups: []interface{}{ &MetricGroupProperty{ MetricData: []interface{}{ &MetricDataItemsProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Value: value, // the properties below are optional Notes: jsii.String("notes"), XAxisName: []*string{ jsii.String("xAxisName"), }, YAxisName: []*string{ jsii.String("yAxisName"), }, }, }, Name: jsii.String("name"), }, }, }, }, IntendedUses: &IntendedUsesProperty{ ExplanationsForRiskRating: jsii.String("explanationsForRiskRating"), FactorsAffectingModelEfficiency: jsii.String("factorsAffectingModelEfficiency"), IntendedUses: jsii.String("intendedUses"), PurposeOfModel: jsii.String("purposeOfModel"), RiskRating: jsii.String("riskRating"), }, ModelOverview: &ModelOverviewProperty{ AlgorithmType: jsii.String("algorithmType"), InferenceEnvironment: &InferenceEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, ModelArtifact: []*string{ jsii.String("modelArtifact"), }, ModelCreator: jsii.String("modelCreator"), ModelDescription: jsii.String("modelDescription"), ModelId: jsii.String("modelId"), ModelName: jsii.String("modelName"), ModelOwner: jsii.String("modelOwner"), ModelVersion: jsii.Number(123), ProblemType: jsii.String("problemType"), }, ModelPackageDetails: &ModelPackageDetailsProperty{ ApprovalDescription: jsii.String("approvalDescription"), CreatedBy: &ModelPackageCreatorProperty{ UserProfileName: jsii.String("userProfileName"), }, Domain: jsii.String("domain"), InferenceSpecification: &InferenceSpecificationProperty{ Containers: []interface{}{ &ContainerProperty{ Image: jsii.String("image"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), NearestModelName: jsii.String("nearestModelName"), }, }, }, ModelApprovalStatus: jsii.String("modelApprovalStatus"), ModelPackageArn: jsii.String("modelPackageArn"), ModelPackageDescription: jsii.String("modelPackageDescription"), ModelPackageGroupName: jsii.String("modelPackageGroupName"), ModelPackageName: jsii.String("modelPackageName"), ModelPackageStatus: jsii.String("modelPackageStatus"), ModelPackageVersion: jsii.Number(123), SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, Task: jsii.String("task"), }, TrainingDetails: &TrainingDetailsProperty{ ObjectiveFunction: &ObjectiveFunctionProperty{ Function: &FunctionProperty{ Condition: jsii.String("condition"), Facet: jsii.String("facet"), Function: jsii.String("function"), }, Notes: jsii.String("notes"), }, TrainingJobDetails: &TrainingJobDetailsProperty{ HyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, TrainingArn: jsii.String("trainingArn"), TrainingDatasets: []*string{ jsii.String("trainingDatasets"), }, TrainingEnvironment: &TrainingEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, TrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, UserProvidedHyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, UserProvidedTrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, }, TrainingObservations: jsii.String("trainingObservations"), }, }, ModelCardName: jsii.String("modelCardName"), ModelCardStatus: jsii.String("modelCardStatus"), // the properties below are optional CreatedBy: &UserContextProperty{ DomainId: jsii.String("domainId"), UserProfileArn: jsii.String("userProfileArn"), UserProfileName: jsii.String("userProfileName"), }, LastModifiedBy: &UserContextProperty{ DomainId: jsii.String("domainId"), UserProfileArn: jsii.String("userProfileArn"), UserProfileName: jsii.String("userProfileName"), }, SecurityConfig: &SecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html
type CfnModelCard_AdditionalInformationProperty ¶ added in v2.64.0
type CfnModelCard_AdditionalInformationProperty struct { // Caveats and recommendations for those who might use this model in their applications. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html#cfn-sagemaker-modelcard-additionalinformation-caveatsandrecommendations // CaveatsAndRecommendations *string `field:"optional" json:"caveatsAndRecommendations" yaml:"caveatsAndRecommendations"` // Any additional information to document about the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html#cfn-sagemaker-modelcard-additionalinformation-customdetails // CustomDetails interface{} `field:"optional" json:"customDetails" yaml:"customDetails"` // Any ethical considerations documented by the model card author. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html#cfn-sagemaker-modelcard-additionalinformation-ethicalconsiderations // EthicalConsiderations *string `field:"optional" json:"ethicalConsiderations" yaml:"ethicalConsiderations"` }
Additional information about the model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" additionalInformationProperty := &AdditionalInformationProperty{ CaveatsAndRecommendations: jsii.String("caveatsAndRecommendations"), CustomDetails: map[string]*string{ "customDetailsKey": jsii.String("customDetails"), }, EthicalConsiderations: jsii.String("ethicalConsiderations"), }
type CfnModelCard_BusinessDetailsProperty ¶ added in v2.64.0
type CfnModelCard_BusinessDetailsProperty struct { // The specific business problem that the model is trying to solve. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html#cfn-sagemaker-modelcard-businessdetails-businessproblem // BusinessProblem *string `field:"optional" json:"businessProblem" yaml:"businessProblem"` // The relevant stakeholders for the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html#cfn-sagemaker-modelcard-businessdetails-businessstakeholders // BusinessStakeholders *string `field:"optional" json:"businessStakeholders" yaml:"businessStakeholders"` // The broader business need that the model is serving. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html#cfn-sagemaker-modelcard-businessdetails-lineofbusiness // LineOfBusiness *string `field:"optional" json:"lineOfBusiness" yaml:"lineOfBusiness"` }
Information about how the model supports business goals.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" businessDetailsProperty := &BusinessDetailsProperty{ BusinessProblem: jsii.String("businessProblem"), BusinessStakeholders: jsii.String("businessStakeholders"), LineOfBusiness: jsii.String("lineOfBusiness"), }
type CfnModelCard_ContainerProperty ¶ added in v2.80.0
type CfnModelCard_ContainerProperty struct { // Inference environment path. // // The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html#cfn-sagemaker-modelcard-container-image // Image *string `field:"required" json:"image" yaml:"image"` // The Amazon S3 path where the model artifacts, which result from model training, are stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html#cfn-sagemaker-modelcard-container-modeldataurl // ModelDataUrl *string `field:"optional" json:"modelDataUrl" yaml:"modelDataUrl"` // The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html#cfn-sagemaker-modelcard-container-nearestmodelname // NearestModelName *string `field:"optional" json:"nearestModelName" yaml:"nearestModelName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" containerProperty := &ContainerProperty{ Image: jsii.String("image"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), NearestModelName: jsii.String("nearestModelName"), }
type CfnModelCard_ContentProperty ¶ added in v2.64.0
type CfnModelCard_ContentProperty struct { // Additional information about the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-additionalinformation // AdditionalInformation interface{} `field:"optional" json:"additionalInformation" yaml:"additionalInformation"` // Information about how the model supports business goals. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-businessdetails // BusinessDetails interface{} `field:"optional" json:"businessDetails" yaml:"businessDetails"` // An overview about the model's evaluation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-evaluationdetails // EvaluationDetails interface{} `field:"optional" json:"evaluationDetails" yaml:"evaluationDetails"` // The intended usage of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-intendeduses // IntendedUses interface{} `field:"optional" json:"intendedUses" yaml:"intendedUses"` // An overview about the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-modeloverview // ModelOverview interface{} `field:"optional" json:"modelOverview" yaml:"modelOverview"` // Metadata information related to model package version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-modelpackagedetails // ModelPackageDetails interface{} `field:"optional" json:"modelPackageDetails" yaml:"modelPackageDetails"` // An overview about model training. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-trainingdetails // TrainingDetails interface{} `field:"optional" json:"trainingDetails" yaml:"trainingDetails"` }
The content of the model card.
It follows the [model card json schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var value interface{} contentProperty := &ContentProperty{ AdditionalInformation: &AdditionalInformationProperty{ CaveatsAndRecommendations: jsii.String("caveatsAndRecommendations"), CustomDetails: map[string]*string{ "customDetailsKey": jsii.String("customDetails"), }, EthicalConsiderations: jsii.String("ethicalConsiderations"), }, BusinessDetails: &BusinessDetailsProperty{ BusinessProblem: jsii.String("businessProblem"), BusinessStakeholders: jsii.String("businessStakeholders"), LineOfBusiness: jsii.String("lineOfBusiness"), }, EvaluationDetails: []interface{}{ &EvaluationDetailProperty{ Name: jsii.String("name"), // the properties below are optional Datasets: []*string{ jsii.String("datasets"), }, EvaluationJobArn: jsii.String("evaluationJobArn"), EvaluationObservation: jsii.String("evaluationObservation"), Metadata: map[string]*string{ "metadataKey": jsii.String("metadata"), }, MetricGroups: []interface{}{ &MetricGroupProperty{ MetricData: []interface{}{ &MetricDataItemsProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Value: value, // the properties below are optional Notes: jsii.String("notes"), XAxisName: []*string{ jsii.String("xAxisName"), }, YAxisName: []*string{ jsii.String("yAxisName"), }, }, }, Name: jsii.String("name"), }, }, }, }, IntendedUses: &IntendedUsesProperty{ ExplanationsForRiskRating: jsii.String("explanationsForRiskRating"), FactorsAffectingModelEfficiency: jsii.String("factorsAffectingModelEfficiency"), IntendedUses: jsii.String("intendedUses"), PurposeOfModel: jsii.String("purposeOfModel"), RiskRating: jsii.String("riskRating"), }, ModelOverview: &ModelOverviewProperty{ AlgorithmType: jsii.String("algorithmType"), InferenceEnvironment: &InferenceEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, ModelArtifact: []*string{ jsii.String("modelArtifact"), }, ModelCreator: jsii.String("modelCreator"), ModelDescription: jsii.String("modelDescription"), ModelId: jsii.String("modelId"), ModelName: jsii.String("modelName"), ModelOwner: jsii.String("modelOwner"), ModelVersion: jsii.Number(123), ProblemType: jsii.String("problemType"), }, ModelPackageDetails: &ModelPackageDetailsProperty{ ApprovalDescription: jsii.String("approvalDescription"), CreatedBy: &ModelPackageCreatorProperty{ UserProfileName: jsii.String("userProfileName"), }, Domain: jsii.String("domain"), InferenceSpecification: &InferenceSpecificationProperty{ Containers: []interface{}{ &ContainerProperty{ Image: jsii.String("image"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), NearestModelName: jsii.String("nearestModelName"), }, }, }, ModelApprovalStatus: jsii.String("modelApprovalStatus"), ModelPackageArn: jsii.String("modelPackageArn"), ModelPackageDescription: jsii.String("modelPackageDescription"), ModelPackageGroupName: jsii.String("modelPackageGroupName"), ModelPackageName: jsii.String("modelPackageName"), ModelPackageStatus: jsii.String("modelPackageStatus"), ModelPackageVersion: jsii.Number(123), SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, Task: jsii.String("task"), }, TrainingDetails: &TrainingDetailsProperty{ ObjectiveFunction: &ObjectiveFunctionProperty{ Function: &FunctionProperty{ Condition: jsii.String("condition"), Facet: jsii.String("facet"), Function: jsii.String("function"), }, Notes: jsii.String("notes"), }, TrainingJobDetails: &TrainingJobDetailsProperty{ HyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, TrainingArn: jsii.String("trainingArn"), TrainingDatasets: []*string{ jsii.String("trainingDatasets"), }, TrainingEnvironment: &TrainingEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, TrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, UserProvidedHyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, UserProvidedTrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, }, TrainingObservations: jsii.String("trainingObservations"), }, }
type CfnModelCard_EvaluationDetailProperty ¶ added in v2.64.0
type CfnModelCard_EvaluationDetailProperty struct { // The evaluation job name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-name // Name *string `field:"required" json:"name" yaml:"name"` // The location of the datasets used to evaluate the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-datasets // Datasets *[]*string `field:"optional" json:"datasets" yaml:"datasets"` // The Amazon Resource Name (ARN) of the evaluation job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-evaluationjobarn // EvaluationJobArn *string `field:"optional" json:"evaluationJobArn" yaml:"evaluationJobArn"` // Any observations made during the model evaluation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-evaluationobservation // EvaluationObservation *string `field:"optional" json:"evaluationObservation" yaml:"evaluationObservation"` // Additional attributes associated with the evaluation results. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-metadata // Metadata interface{} `field:"optional" json:"metadata" yaml:"metadata"` // An evaluation Metric Group object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-metricgroups // MetricGroups interface{} `field:"optional" json:"metricGroups" yaml:"metricGroups"` }
The evaluation details of the model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var value interface{} evaluationDetailProperty := &EvaluationDetailProperty{ Name: jsii.String("name"), // the properties below are optional Datasets: []*string{ jsii.String("datasets"), }, EvaluationJobArn: jsii.String("evaluationJobArn"), EvaluationObservation: jsii.String("evaluationObservation"), Metadata: map[string]*string{ "metadataKey": jsii.String("metadata"), }, MetricGroups: []interface{}{ &MetricGroupProperty{ MetricData: []interface{}{ &MetricDataItemsProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Value: value, // the properties below are optional Notes: jsii.String("notes"), XAxisName: []*string{ jsii.String("xAxisName"), }, YAxisName: []*string{ jsii.String("yAxisName"), }, }, }, Name: jsii.String("name"), }, }, }
type CfnModelCard_FunctionProperty ¶ added in v2.64.0
type CfnModelCard_FunctionProperty struct { // An optional description of any conditions of your objective function metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-function.html#cfn-sagemaker-modelcard-function-condition // Condition *string `field:"optional" json:"condition" yaml:"condition"` // The metric of the model's objective function. // // For example, *loss* or *rmse* . The following list shows examples of the values that you can specify for the metric: // // - `ACCURACY` // - `AUC` // - `LOSS` // - `MAE` // - `RMSE`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-function.html#cfn-sagemaker-modelcard-function-facet // Facet *string `field:"optional" json:"facet" yaml:"facet"` // The optimization direction of the model's objective function. You must specify one of the following values:. // // - `Maximize` // - `Minimize`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-function.html#cfn-sagemaker-modelcard-function-function // Function *string `field:"optional" json:"function" yaml:"function"` }
Function details.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" functionProperty := &FunctionProperty{ Condition: jsii.String("condition"), Facet: jsii.String("facet"), Function: jsii.String("function"), }
type CfnModelCard_InferenceEnvironmentProperty ¶ added in v2.64.0
type CfnModelCard_InferenceEnvironmentProperty struct { // The container used to run the inference environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferenceenvironment.html#cfn-sagemaker-modelcard-inferenceenvironment-containerimage // ContainerImage *[]*string `field:"optional" json:"containerImage" yaml:"containerImage"` }
An overview of a model's inference environment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceEnvironmentProperty := &InferenceEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }
type CfnModelCard_InferenceSpecificationProperty ¶ added in v2.80.0
type CfnModelCard_InferenceSpecificationProperty struct { // The Amazon ECR registry path of the Docker image that contains the inference code. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferencespecification.html#cfn-sagemaker-modelcard-inferencespecification-containers // Containers interface{} `field:"required" json:"containers" yaml:"containers"` }
Defines how to perform inference generation after a training job is run.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceSpecificationProperty := &InferenceSpecificationProperty{ Containers: []interface{}{ &ContainerProperty{ Image: jsii.String("image"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), NearestModelName: jsii.String("nearestModelName"), }, }, }
type CfnModelCard_IntendedUsesProperty ¶ added in v2.64.0
type CfnModelCard_IntendedUsesProperty struct { // An explanation of why your organization categorizes the model with its risk rating. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-explanationsforriskrating // ExplanationsForRiskRating *string `field:"optional" json:"explanationsForRiskRating" yaml:"explanationsForRiskRating"` // Factors affecting model efficacy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-factorsaffectingmodelefficiency // FactorsAffectingModelEfficiency *string `field:"optional" json:"factorsAffectingModelEfficiency" yaml:"factorsAffectingModelEfficiency"` // The intended use cases for the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-intendeduses // IntendedUses *string `field:"optional" json:"intendedUses" yaml:"intendedUses"` // The general purpose of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-purposeofmodel // PurposeOfModel *string `field:"optional" json:"purposeOfModel" yaml:"purposeOfModel"` // Your organization's risk rating. You can specify one the following values as the risk rating:. // // - High // - Medium // - Low // - Unknown. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-riskrating // RiskRating *string `field:"optional" json:"riskRating" yaml:"riskRating"` }
The intended uses of a model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" intendedUsesProperty := &IntendedUsesProperty{ ExplanationsForRiskRating: jsii.String("explanationsForRiskRating"), FactorsAffectingModelEfficiency: jsii.String("factorsAffectingModelEfficiency"), IntendedUses: jsii.String("intendedUses"), PurposeOfModel: jsii.String("purposeOfModel"), RiskRating: jsii.String("riskRating"), }
type CfnModelCard_MetricDataItemsProperty ¶ added in v2.64.0
type CfnModelCard_MetricDataItemsProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html#cfn-sagemaker-modelcard-metricdataitems-name // Name *string `field:"required" json:"name" yaml:"name"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html#cfn-sagemaker-modelcard-metricdataitems-type // Type *string `field:"required" json:"type" yaml:"type"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html#cfn-sagemaker-modelcard-metricdataitems-value // Value interface{} `field:"required" json:"value" yaml:"value"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html#cfn-sagemaker-modelcard-metricdataitems-notes // Notes *string `field:"optional" json:"notes" yaml:"notes"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html#cfn-sagemaker-modelcard-metricdataitems-xaxisname // XAxisName *[]*string `field:"optional" json:"xAxisName" yaml:"xAxisName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html#cfn-sagemaker-modelcard-metricdataitems-yaxisname // YAxisName *[]*string `field:"optional" json:"yAxisName" yaml:"yAxisName"` }
Metric data.
The `type` determines the data types that you specify for `value` , `XAxisName` and `YAxisName` . For information about specifying values for metrics, see [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var value interface{} metricDataItemsProperty := &MetricDataItemsProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Value: value, // the properties below are optional Notes: jsii.String("notes"), XAxisName: []*string{ jsii.String("xAxisName"), }, YAxisName: []*string{ jsii.String("yAxisName"), }, }
type CfnModelCard_MetricGroupProperty ¶ added in v2.64.0
type CfnModelCard_MetricGroupProperty struct { // A list of metric objects. The `MetricDataItems` list can have one of the following values:. // // - `bar_chart_metric` // - `matrix_metric` // - `simple_metric` // - `linear_graph_metric` // // For more information about the metric schema, see the definition section of the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html#cfn-sagemaker-modelcard-metricgroup-metricdata // MetricData interface{} `field:"required" json:"metricData" yaml:"metricData"` // The metric group name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html#cfn-sagemaker-modelcard-metricgroup-name // Name *string `field:"required" json:"name" yaml:"name"` }
A group of metric data that you use to initialize a metric group object.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var value interface{} metricGroupProperty := &MetricGroupProperty{ MetricData: []interface{}{ &MetricDataItemsProperty{ Name: jsii.String("name"), Type: jsii.String("type"), Value: value, // the properties below are optional Notes: jsii.String("notes"), XAxisName: []*string{ jsii.String("xAxisName"), }, YAxisName: []*string{ jsii.String("yAxisName"), }, }, }, Name: jsii.String("name"), }
type CfnModelCard_ModelOverviewProperty ¶ added in v2.64.0
type CfnModelCard_ModelOverviewProperty struct { // The algorithm used to solve the problem. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-algorithmtype // AlgorithmType *string `field:"optional" json:"algorithmType" yaml:"algorithmType"` // An overview about model inference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-inferenceenvironment // InferenceEnvironment interface{} `field:"optional" json:"inferenceEnvironment" yaml:"inferenceEnvironment"` // The location of the model artifact. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelartifact // ModelArtifact *[]*string `field:"optional" json:"modelArtifact" yaml:"modelArtifact"` // The creator of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelcreator // ModelCreator *string `field:"optional" json:"modelCreator" yaml:"modelCreator"` // A description of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modeldescription // ModelDescription *string `field:"optional" json:"modelDescription" yaml:"modelDescription"` // The SageMaker Model ARN or non- SageMaker Model ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelid // ModelId *string `field:"optional" json:"modelId" yaml:"modelId"` // The name of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelname // ModelName *string `field:"optional" json:"modelName" yaml:"modelName"` // The owner of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelowner // ModelOwner *string `field:"optional" json:"modelOwner" yaml:"modelOwner"` // The version of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelversion // ModelVersion *float64 `field:"optional" json:"modelVersion" yaml:"modelVersion"` // The problem being solved with the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-problemtype // ProblemType *string `field:"optional" json:"problemType" yaml:"problemType"` }
An overview about the model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelOverviewProperty := &ModelOverviewProperty{ AlgorithmType: jsii.String("algorithmType"), InferenceEnvironment: &InferenceEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, ModelArtifact: []*string{ jsii.String("modelArtifact"), }, ModelCreator: jsii.String("modelCreator"), ModelDescription: jsii.String("modelDescription"), ModelId: jsii.String("modelId"), ModelName: jsii.String("modelName"), ModelOwner: jsii.String("modelOwner"), ModelVersion: jsii.Number(123), ProblemType: jsii.String("problemType"), }
type CfnModelCard_ModelPackageCreatorProperty ¶ added in v2.80.0
type CfnModelCard_ModelPackageCreatorProperty struct { // The name of the user's profile in Studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagecreator.html#cfn-sagemaker-modelcard-modelpackagecreator-userprofilename // UserProfileName *string `field:"optional" json:"userProfileName" yaml:"userProfileName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelPackageCreatorProperty := &ModelPackageCreatorProperty{ UserProfileName: jsii.String("userProfileName"), }
type CfnModelCard_ModelPackageDetailsProperty ¶ added in v2.80.0
type CfnModelCard_ModelPackageDetailsProperty struct { // A description provided for the model approval. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-approvaldescription // ApprovalDescription *string `field:"optional" json:"approvalDescription" yaml:"approvalDescription"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-createdby // CreatedBy interface{} `field:"optional" json:"createdBy" yaml:"createdBy"` // The machine learning domain of the model package you specified. // // Common machine learning domains include computer vision and natural language processing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-domain // Domain *string `field:"optional" json:"domain" yaml:"domain"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-inferencespecification // InferenceSpecification interface{} `field:"optional" json:"inferenceSpecification" yaml:"inferenceSpecification"` // Current approval status of model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelapprovalstatus // ModelApprovalStatus *string `field:"optional" json:"modelApprovalStatus" yaml:"modelApprovalStatus"` // The Amazon Resource Name (ARN) of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagearn // ModelPackageArn *string `field:"optional" json:"modelPackageArn" yaml:"modelPackageArn"` // A brief summary of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagedescription // ModelPackageDescription *string `field:"optional" json:"modelPackageDescription" yaml:"modelPackageDescription"` // If the model is a versioned model, the name of the model group that the versioned model belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagegroupname // ModelPackageGroupName *string `field:"optional" json:"modelPackageGroupName" yaml:"modelPackageGroupName"` // Name of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagename // ModelPackageName *string `field:"optional" json:"modelPackageName" yaml:"modelPackageName"` // Current status of model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagestatus // ModelPackageStatus *string `field:"optional" json:"modelPackageStatus" yaml:"modelPackageStatus"` // Version of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackageversion // ModelPackageVersion *float64 `field:"optional" json:"modelPackageVersion" yaml:"modelPackageVersion"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-sourcealgorithms // SourceAlgorithms interface{} `field:"optional" json:"sourceAlgorithms" yaml:"sourceAlgorithms"` // The machine learning task you specified that your model package accomplishes. // // Common machine learning tasks include object detection and image classification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-task // Task *string `field:"optional" json:"task" yaml:"task"` }
Metadata information related to model package version.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelPackageDetailsProperty := &ModelPackageDetailsProperty{ ApprovalDescription: jsii.String("approvalDescription"), CreatedBy: &ModelPackageCreatorProperty{ UserProfileName: jsii.String("userProfileName"), }, Domain: jsii.String("domain"), InferenceSpecification: &InferenceSpecificationProperty{ Containers: []interface{}{ &ContainerProperty{ Image: jsii.String("image"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), NearestModelName: jsii.String("nearestModelName"), }, }, }, ModelApprovalStatus: jsii.String("modelApprovalStatus"), ModelPackageArn: jsii.String("modelPackageArn"), ModelPackageDescription: jsii.String("modelPackageDescription"), ModelPackageGroupName: jsii.String("modelPackageGroupName"), ModelPackageName: jsii.String("modelPackageName"), ModelPackageStatus: jsii.String("modelPackageStatus"), ModelPackageVersion: jsii.Number(123), SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, Task: jsii.String("task"), }
type CfnModelCard_ObjectiveFunctionProperty ¶ added in v2.64.0
type CfnModelCard_ObjectiveFunctionProperty struct { // A function object that details optimization direction, metric, and additional descriptions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html#cfn-sagemaker-modelcard-objectivefunction-function // Function interface{} `field:"optional" json:"function" yaml:"function"` // Notes about the object function, including other considerations for possible objective functions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html#cfn-sagemaker-modelcard-objectivefunction-notes // Notes *string `field:"optional" json:"notes" yaml:"notes"` }
The function that is optimized during model training.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" objectiveFunctionProperty := &ObjectiveFunctionProperty{ Function: &FunctionProperty{ Condition: jsii.String("condition"), Facet: jsii.String("facet"), Function: jsii.String("function"), }, Notes: jsii.String("notes"), }
type CfnModelCard_SecurityConfigProperty ¶ added in v2.64.0
type CfnModelCard_SecurityConfigProperty struct { // A AWS Key Management Service [key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) used to encrypt a model card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-securityconfig.html#cfn-sagemaker-modelcard-securityconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The security configuration used to protect model card data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" securityConfigProperty := &SecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }
type CfnModelCard_SourceAlgorithmProperty ¶ added in v2.80.0
type CfnModelCard_SourceAlgorithmProperty struct { // The name of an algorithm that was used to create the model package. // // The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html#cfn-sagemaker-modelcard-sourcealgorithm-algorithmname // AlgorithmName *string `field:"required" json:"algorithmName" yaml:"algorithmName"` // The Amazon 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 model artifacts must be in an S3 bucket that is in the same AWS region as the algorithm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html#cfn-sagemaker-modelcard-sourcealgorithm-modeldataurl // ModelDataUrl *string `field:"optional" json:"modelDataUrl" yaml:"modelDataUrl"` }
Specifies an algorithm that was used to create the model package.
The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sourceAlgorithmProperty := &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }
type CfnModelCard_TrainingDetailsProperty ¶ added in v2.64.0
type CfnModelCard_TrainingDetailsProperty struct { // The function that is optimized during model training. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html#cfn-sagemaker-modelcard-trainingdetails-objectivefunction // ObjectiveFunction interface{} `field:"optional" json:"objectiveFunction" yaml:"objectiveFunction"` // Details about any associated training jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html#cfn-sagemaker-modelcard-trainingdetails-trainingjobdetails // TrainingJobDetails interface{} `field:"optional" json:"trainingJobDetails" yaml:"trainingJobDetails"` // Any observations about training. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html#cfn-sagemaker-modelcard-trainingdetails-trainingobservations // TrainingObservations *string `field:"optional" json:"trainingObservations" yaml:"trainingObservations"` }
The training details of the model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trainingDetailsProperty := &TrainingDetailsProperty{ ObjectiveFunction: &ObjectiveFunctionProperty{ Function: &FunctionProperty{ Condition: jsii.String("condition"), Facet: jsii.String("facet"), Function: jsii.String("function"), }, Notes: jsii.String("notes"), }, TrainingJobDetails: &TrainingJobDetailsProperty{ HyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, TrainingArn: jsii.String("trainingArn"), TrainingDatasets: []*string{ jsii.String("trainingDatasets"), }, TrainingEnvironment: &TrainingEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, TrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, UserProvidedHyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, UserProvidedTrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, }, TrainingObservations: jsii.String("trainingObservations"), }
type CfnModelCard_TrainingEnvironmentProperty ¶ added in v2.64.0
type CfnModelCard_TrainingEnvironmentProperty struct { // SageMaker inference image URI. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingenvironment.html#cfn-sagemaker-modelcard-trainingenvironment-containerimage // ContainerImage *[]*string `field:"optional" json:"containerImage" yaml:"containerImage"` }
SageMaker training image.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trainingEnvironmentProperty := &TrainingEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }
type CfnModelCard_TrainingHyperParameterProperty ¶ added in v2.64.0
type CfnModelCard_TrainingHyperParameterProperty struct { // The name of the hyper parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html#cfn-sagemaker-modelcard-traininghyperparameter-name // Name *string `field:"required" json:"name" yaml:"name"` // The value specified for the hyper parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html#cfn-sagemaker-modelcard-traininghyperparameter-value // Value *string `field:"required" json:"value" yaml:"value"` }
A hyper parameter that was configured in training the model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trainingHyperParameterProperty := &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnModelCard_TrainingJobDetailsProperty ¶ added in v2.64.0
type CfnModelCard_TrainingJobDetailsProperty struct { // The hyper parameters used in the training job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-hyperparameters // HyperParameters interface{} `field:"optional" json:"hyperParameters" yaml:"hyperParameters"` // The SageMaker training job Amazon Resource Name (ARN). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingarn // TrainingArn *string `field:"optional" json:"trainingArn" yaml:"trainingArn"` // The location of the datasets used to train the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingdatasets // TrainingDatasets *[]*string `field:"optional" json:"trainingDatasets" yaml:"trainingDatasets"` // The SageMaker training job image URI. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingenvironment // TrainingEnvironment interface{} `field:"optional" json:"trainingEnvironment" yaml:"trainingEnvironment"` // The SageMaker training job results. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-trainingmetrics // TrainingMetrics interface{} `field:"optional" json:"trainingMetrics" yaml:"trainingMetrics"` // Additional hyper parameters that you've specified when training the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedhyperparameters // UserProvidedHyperParameters interface{} `field:"optional" json:"userProvidedHyperParameters" yaml:"userProvidedHyperParameters"` // Custom training job results. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedtrainingmetrics // UserProvidedTrainingMetrics interface{} `field:"optional" json:"userProvidedTrainingMetrics" yaml:"userProvidedTrainingMetrics"` }
The overview of a training job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trainingJobDetailsProperty := &TrainingJobDetailsProperty{ HyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, TrainingArn: jsii.String("trainingArn"), TrainingDatasets: []*string{ jsii.String("trainingDatasets"), }, TrainingEnvironment: &TrainingEnvironmentProperty{ ContainerImage: []*string{ jsii.String("containerImage"), }, }, TrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, UserProvidedHyperParameters: []interface{}{ &TrainingHyperParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, UserProvidedTrainingMetrics: []interface{}{ &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }, }, }
type CfnModelCard_TrainingMetricProperty ¶ added in v2.64.0
type CfnModelCard_TrainingMetricProperty struct { // The name of the result from the SageMaker training job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html#cfn-sagemaker-modelcard-trainingmetric-name // Name *string `field:"required" json:"name" yaml:"name"` // The value of a result from the SageMaker training job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html#cfn-sagemaker-modelcard-trainingmetric-value // Value *float64 `field:"required" json:"value" yaml:"value"` // Any additional notes describing the result of the training job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html#cfn-sagemaker-modelcard-trainingmetric-notes // Notes *string `field:"optional" json:"notes" yaml:"notes"` }
A result from a SageMaker training job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trainingMetricProperty := &TrainingMetricProperty{ Name: jsii.String("name"), Value: jsii.Number(123), // the properties below are optional Notes: jsii.String("notes"), }
type CfnModelCard_UserContextProperty ¶ added in v2.64.0
type CfnModelCard_UserContextProperty struct { // The domain associated with the user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-domainid // // Default: - "UnsetValue". // DomainId *string `field:"optional" json:"domainId" yaml:"domainId"` // The Amazon Resource Name (ARN) of the user's profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilearn // // Default: - "UnsetValue". // UserProfileArn *string `field:"optional" json:"userProfileArn" yaml:"userProfileArn"` // The name of the user's profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilename // // Default: - "UnsetValue". // UserProfileName *string `field:"optional" json:"userProfileName" yaml:"userProfileName"` }
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" userContextProperty := &UserContextProperty{ DomainId: jsii.String("domainId"), UserProfileArn: jsii.String("userProfileArn"), UserProfileName: jsii.String("userProfileName"), }
type CfnModelExplainabilityJobDefinition ¶
type CfnModelExplainabilityJobDefinition interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time when the job definition was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the job definition. AttrJobDefinitionArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the endpoint used to run the monitoring job. EndpointName() *string SetEndpointName(val *string) // The name of the model explainability job definition. JobDefinitionName() *string SetJobDefinitionName(val *string) // Identifies the resources to deploy for a monitoring job. JobResources() interface{} SetJobResources(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Configures the model explainability job to run a specified Docker container image. ModelExplainabilityAppSpecification() interface{} SetModelExplainabilityAppSpecification(val interface{}) // The baseline configuration for a model explainability job. ModelExplainabilityBaselineConfig() interface{} SetModelExplainabilityBaselineConfig(val interface{}) // Inputs for the model explainability job. ModelExplainabilityJobInput() interface{} SetModelExplainabilityJobInput(val interface{}) // The output configuration for monitoring jobs. ModelExplainabilityJobOutputConfig() interface{} SetModelExplainabilityJobOutputConfig(val interface{}) // Networking options for a model explainability job. NetworkConfig() interface{} SetNetworkConfig(val interface{}) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A time limit for how long the monitoring job is allowed to run before stopping. StoppingCondition() interface{} SetStoppingCondition(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates the definition for a model explainability job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnModelExplainabilityJobDefinition := awscdk.Aws_sagemaker.NewCfnModelExplainabilityJobDefinition(this, jsii.String("MyCfnModelExplainabilityJobDefinition"), &CfnModelExplainabilityJobDefinitionProps{ JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, ModelExplainabilityAppSpecification: &ModelExplainabilityAppSpecificationProperty{ ConfigUri: jsii.String("configUri"), ImageUri: jsii.String("imageUri"), // the properties below are optional Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, }, ModelExplainabilityJobInput: &ModelExplainabilityJobInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, ModelExplainabilityJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), ModelExplainabilityBaselineConfig: &ModelExplainabilityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnModelExplainabilityJobDefinition ¶
func NewCfnModelExplainabilityJobDefinition(scope constructs.Construct, id *string, props *CfnModelExplainabilityJobDefinitionProps) CfnModelExplainabilityJobDefinition
type CfnModelExplainabilityJobDefinitionProps ¶
type CfnModelExplainabilityJobDefinitionProps struct { // Identifies the resources to deploy for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobresources // JobResources interface{} `field:"required" json:"jobResources" yaml:"jobResources"` // Configures the model explainability job to run a specified Docker container image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification // ModelExplainabilityAppSpecification interface{} `field:"required" json:"modelExplainabilityAppSpecification" yaml:"modelExplainabilityAppSpecification"` // Inputs for the model explainability job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput // ModelExplainabilityJobInput interface{} `field:"required" json:"modelExplainabilityJobInput" yaml:"modelExplainabilityJobInput"` // The output configuration for monitoring jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjoboutputconfig // ModelExplainabilityJobOutputConfig interface{} `field:"required" json:"modelExplainabilityJobOutputConfig" yaml:"modelExplainabilityJobOutputConfig"` // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the endpoint used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // The name of the model explainability job definition. // // The name must be unique within an AWS Region in the AWS account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobdefinitionname // JobDefinitionName *string `field:"optional" json:"jobDefinitionName" yaml:"jobDefinitionName"` // The baseline configuration for a model explainability job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig // ModelExplainabilityBaselineConfig interface{} `field:"optional" json:"modelExplainabilityBaselineConfig" yaml:"modelExplainabilityBaselineConfig"` // Networking options for a model explainability job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-networkconfig // NetworkConfig interface{} `field:"optional" json:"networkConfig" yaml:"networkConfig"` // A time limit for how long the monitoring job is allowed to run before stopping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-stoppingcondition // StoppingCondition interface{} `field:"optional" json:"stoppingCondition" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnModelExplainabilityJobDefinition`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnModelExplainabilityJobDefinitionProps := &CfnModelExplainabilityJobDefinitionProps{ JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, ModelExplainabilityAppSpecification: &ModelExplainabilityAppSpecificationProperty{ ConfigUri: jsii.String("configUri"), ImageUri: jsii.String("imageUri"), // the properties below are optional Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, }, ModelExplainabilityJobInput: &ModelExplainabilityJobInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, ModelExplainabilityJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), ModelExplainabilityBaselineConfig: &ModelExplainabilityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnModelExplainabilityJobDefinition_BatchTransformInputProperty ¶ added in v2.48.0
type CfnModelExplainabilityJobDefinition_BatchTransformInputProperty struct { // The Amazon S3 location being used to capture the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-datacaptureddestinations3uri // DataCapturedDestinationS3Uri *string `field:"required" json:"dataCapturedDestinationS3Uri" yaml:"dataCapturedDestinationS3Uri"` // The dataset format for your batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-datasetformat // DatasetFormat interface{} `field:"required" json:"datasetFormat" yaml:"datasetFormat"` // Path to the filesystem where the batch transform data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // The attributes of the input data that are the input features. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-featuresattribute // FeaturesAttribute *string `field:"optional" json:"featuresAttribute" yaml:"featuresAttribute"` // The attribute of the input data that represents the ground truth label. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-inferenceattribute // InferenceAttribute *string `field:"optional" json:"inferenceAttribute" yaml:"inferenceAttribute"` // In a classification problem, the attribute that represents the class probability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelexplainabilityjobdefinition-batchtransforminput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"s3InputMode"` }
Input object for the batch transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" batchTransformInputProperty := &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The ML compute instance type for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The size of the ML storage volume, in gigabytes, that you want to provision. // // You must specify sufficient ML storage for your scenario. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-volumesizeingb // VolumeSizeInGb *float64 `field:"required" json:"volumeSizeInGb" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-volumekmskeyid // VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"` }
The configuration for the cluster resources used to run the processing job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterConfigProperty := &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }
type CfnModelExplainabilityJobDefinition_ConstraintsResourceProperty ¶
type CfnModelExplainabilityJobDefinition_ConstraintsResourceProperty struct { // The Amazon S3 URI for the constraints resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-constraintsresource.html#cfn-sagemaker-modelexplainabilityjobdefinition-constraintsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
Input object for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" constraintsResourceProperty := &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnModelExplainabilityJobDefinition_CsvProperty ¶ added in v2.48.0
type CfnModelExplainabilityJobDefinition_CsvProperty struct { // A boolean flag indicating if given CSV has header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-csv.html#cfn-sagemaker-modelexplainabilityjobdefinition-csv-header // Header interface{} `field:"optional" json:"header" yaml:"header"` }
The CSV format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvProperty := &CsvProperty{ Header: jsii.Boolean(false), }
type CfnModelExplainabilityJobDefinition_DatasetFormatProperty ¶ added in v2.48.0
type CfnModelExplainabilityJobDefinition_DatasetFormatProperty struct { // The CSV format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-datasetformat.html#cfn-sagemaker-modelexplainabilityjobdefinition-datasetformat-csv // Csv interface{} `field:"optional" json:"csv" yaml:"csv"` // The Json format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-datasetformat.html#cfn-sagemaker-modelexplainabilityjobdefinition-datasetformat-json // Json interface{} `field:"optional" json:"json" yaml:"json"` // A flag indicating if the dataset format is Parquet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-datasetformat.html#cfn-sagemaker-modelexplainabilityjobdefinition-datasetformat-parquet // Parquet interface{} `field:"optional" json:"parquet" yaml:"parquet"` }
The dataset format of the data to monitor.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetFormatProperty := &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }
type CfnModelExplainabilityJobDefinition_EndpointInputProperty ¶
type CfnModelExplainabilityJobDefinition_EndpointInputProperty struct { // An endpoint in customer's account which has enabled `DataCaptureConfig` enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // Path to the filesystem where the endpoint data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // The attributes of the input data that are the input features. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-featuresattribute // FeaturesAttribute *string `field:"optional" json:"featuresAttribute" yaml:"featuresAttribute"` // The attribute of the input data that represents the ground truth label. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-inferenceattribute // InferenceAttribute *string `field:"optional" json:"inferenceAttribute" yaml:"inferenceAttribute"` // In a classification problem, the attribute that represents the class probability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointinput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"s3InputMode"` }
Input object for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointInputProperty := &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }
type CfnModelExplainabilityJobDefinition_JsonProperty ¶ added in v2.48.0
type CfnModelExplainabilityJobDefinition_JsonProperty struct { // A boolean flag indicating if it is JSON line format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-json.html#cfn-sagemaker-modelexplainabilityjobdefinition-json-line // Line interface{} `field:"optional" json:"line" yaml:"line"` }
The Json format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jsonProperty := &JsonProperty{ Line: jsii.Boolean(false), }
type CfnModelExplainabilityJobDefinition_ModelExplainabilityAppSpecificationProperty ¶
type CfnModelExplainabilityJobDefinition_ModelExplainabilityAppSpecificationProperty struct { // JSON formatted Amazon 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/dg/clarify-config-json-monitor-model-explainability-parameters.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification-configuri // ConfigUri *string `field:"required" json:"configUri" yaml:"configUri"` // The container image to be run by the model explainability job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification-imageuri // ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"` // Sets the environment variables in the Docker container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` }
Docker container image configuration object for the model explainability job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelExplainabilityAppSpecificationProperty := &ModelExplainabilityAppSpecificationProperty{ ConfigUri: jsii.String("configUri"), ImageUri: jsii.String("imageUri"), // the properties below are optional Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, }
type CfnModelExplainabilityJobDefinition_ModelExplainabilityBaselineConfigProperty ¶
type CfnModelExplainabilityJobDefinition_ModelExplainabilityBaselineConfigProperty struct { // The name of the baseline model explainability job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig-baseliningjobname // BaseliningJobName *string `field:"optional" json:"baseliningJobName" yaml:"baseliningJobName"` // The constraints resource for a model explainability job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig-constraintsresource // ConstraintsResource interface{} `field:"optional" json:"constraintsResource" yaml:"constraintsResource"` }
The configuration for a baseline model explainability job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelExplainabilityBaselineConfigProperty := &ModelExplainabilityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }
type CfnModelExplainabilityJobDefinition_ModelExplainabilityJobInputProperty ¶
type CfnModelExplainabilityJobDefinition_ModelExplainabilityJobInputProperty struct { // Input object for the batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput-batchtransforminput // BatchTransformInput interface{} `field:"optional" json:"batchTransformInput" yaml:"batchTransformInput"` // Input object for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput-endpointinput // EndpointInput interface{} `field:"optional" json:"endpointInput" yaml:"endpointInput"` }
Inputs for the model explainability job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelExplainabilityJobInputProperty := &ModelExplainabilityJobInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional FeaturesAttribute: jsii.String("featuresAttribute"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }
type CfnModelExplainabilityJobDefinition_MonitoringOutputConfigProperty ¶
type CfnModelExplainabilityJobDefinition_MonitoringOutputConfigProperty struct { // Monitoring outputs for monitoring jobs. // // This is where the output of the periodic monitoring jobs is uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-monitoringoutputconfig-monitoringoutputs // MonitoringOutputs interface{} `field:"required" json:"monitoringOutputs" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-monitoringoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The output configuration for monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputConfigProperty := &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnModelExplainabilityJobDefinition_MonitoringOutputProperty ¶
type CfnModelExplainabilityJobDefinition_MonitoringOutputProperty struct { // The Amazon S3 storage location where the results of a monitoring job are saved. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-monitoringoutput.html#cfn-sagemaker-modelexplainabilityjobdefinition-monitoringoutput-s3output // S3Output interface{} `field:"required" json:"s3Output" yaml:"s3Output"` }
The output object for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputProperty := &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }
type CfnModelExplainabilityJobDefinition_MonitoringResourcesProperty ¶
type CfnModelExplainabilityJobDefinition_MonitoringResourcesProperty struct { // The configuration for the cluster resources used to run the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-monitoringresources.html#cfn-sagemaker-modelexplainabilityjobdefinition-monitoringresources-clusterconfig // ClusterConfig interface{} `field:"required" json:"clusterConfig" yaml:"clusterConfig"` }
Identifies the resources to deploy for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringResourcesProperty := &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-networkconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-networkconfig-enableintercontainertrafficencryption // EnableInterContainerTrafficEncryption interface{} `field:"optional" json:"enableInterContainerTrafficEncryption" yaml:"enableInterContainerTrafficEncryption"` // Whether to allow inbound and outbound network calls to and from the containers used for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-networkconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-networkconfig-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-networkconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-networkconfig-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" networkConfigProperty := &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-s3output.html#cfn-sagemaker-modelexplainabilityjobdefinition-s3output-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-s3output.html#cfn-sagemaker-modelexplainabilityjobdefinition-s3output-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // Whether to upload the results of the monitoring job continuously or after the job completes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-s3output.html#cfn-sagemaker-modelexplainabilityjobdefinition-s3output-s3uploadmode // S3UploadMode *string `field:"optional" json:"s3UploadMode" yaml:"s3UploadMode"` }
The Amazon S3 storage location where the results of a monitoring job are saved.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3OutputProperty := &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }
type CfnModelExplainabilityJobDefinition_StoppingConditionProperty ¶
type CfnModelExplainabilityJobDefinition_StoppingConditionProperty struct { // The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. // // For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model. // // For all other jobs, if the job does not complete during this time, 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. // // The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-stoppingcondition.html#cfn-sagemaker-modelexplainabilityjobdefinition-stoppingcondition-maxruntimeinseconds // MaxRuntimeInSeconds *float64 `field:"required" json:"maxRuntimeInSeconds" yaml:"maxRuntimeInSeconds"` }
Specifies a limit to how long a job can run.
When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, 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 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stoppingConditionProperty := &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-vpcconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-vpcconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
type CfnModelPackage ¶ added in v2.45.0
type CfnModelPackage interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // An array of additional Inference Specification objects. AdditionalInferenceSpecifications() interface{} SetAdditionalInferenceSpecifications(val interface{}) // An array of additional Inference Specification objects to be added to the existing array. AdditionalInferenceSpecificationsToAdd() interface{} SetAdditionalInferenceSpecificationsToAdd(val interface{}) // A description provided when the model approval is set. ApprovalDescription() *string SetApprovalDescription(val *string) // The time that the model package was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the model package. AttrModelPackageArn() *string // The status of the model package. This can be one of the following values. // // - `PENDING` - The model package creation is pending. // - `IN_PROGRESS` - The model package is in the process of being created. // - `COMPLETED` - The model package was successfully created. // - `FAILED` - The model package creation failed. // - `DELETING` - The model package is in the process of being deleted. AttrModelPackageStatus() *string // Whether the model package is to be certified to be listed on AWS Marketplace. CertifyForMarketplace() interface{} SetCertifyForMarketplace(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // A unique token that guarantees that the call to this API is idempotent. ClientToken() *string SetClientToken(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The metadata properties for the model package. CustomerMetadataProperties() interface{} SetCustomerMetadataProperties(val interface{}) // The machine learning domain of your model package and its components. Domain() *string SetDomain(val *string) // Represents the drift check baselines that can be used when the model monitor is set using the model package. DriftCheckBaselines() interface{} SetDriftCheckBaselines(val interface{}) // Defines how to perform inference generation after a training job is run. InferenceSpecification() interface{} SetInferenceSpecification(val interface{}) // The last time the model package was modified. LastModifiedTime() *string SetLastModifiedTime(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties() interface{} SetMetadataProperties(val interface{}) // The approval status of the model. // // This can be one of the following values. ModelApprovalStatus() *string SetModelApprovalStatus(val *string) // An Amazon SageMaker Model Card. ModelCard() interface{} SetModelCard(val interface{}) // Metrics for the model. ModelMetrics() interface{} SetModelMetrics(val interface{}) // The description of the model package. ModelPackageDescription() *string SetModelPackageDescription(val *string) // The model group to which the model belongs. ModelPackageGroupName() *string SetModelPackageGroupName(val *string) // The name of the model. ModelPackageName() *string SetModelPackageName(val *string) // Specifies the validation and image scan statuses of the model package. ModelPackageStatusDetails() interface{} SetModelPackageStatusDetails(val interface{}) // The version number of a versioned model. ModelPackageVersion() *float64 SetModelPackageVersion(val *float64) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Simple Storage Service path where the sample payload are stored. SamplePayloadUrl() *string SetSamplePayloadUrl(val *string) // An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data. SecurityConfig() interface{} SetSecurityConfig(val interface{}) // Indicates if you want to skip model validation. SkipModelValidation() *string SetSkipModelValidation(val *string) // A list of algorithms that were used to create a model package. SourceAlgorithmSpecification() interface{} SetSourceAlgorithmSpecification(val interface{}) // The URI of the source for the model package. SourceUri() *string SetSourceUri(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of the tags associated with the model package. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The machine learning task your model package accomplishes. Task() *string SetTask(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Specifies batch transform jobs that SageMaker runs to validate your model package. ValidationSpecification() interface{} SetValidationSpecification(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A versioned model that can be deployed for SageMaker inference.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelInput interface{} cfnModelPackage := awscdk.Aws_sagemaker.NewCfnModelPackage(this, jsii.String("MyCfnModelPackage"), &CfnModelPackageProps{ AdditionalInferenceSpecifications: []interface{}{ &AdditionalInferenceSpecificationDefinitionProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }, }, AdditionalInferenceSpecificationsToAdd: []interface{}{ &AdditionalInferenceSpecificationDefinitionProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }, }, ApprovalDescription: jsii.String("approvalDescription"), CertifyForMarketplace: jsii.Boolean(false), ClientToken: jsii.String("clientToken"), CustomerMetadataProperties: map[string]*string{ "customerMetadataPropertiesKey": jsii.String("customerMetadataProperties"), }, Domain: jsii.String("domain"), DriftCheckBaselines: &DriftCheckBaselinesProperty{ Bias: &DriftCheckBiasProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, PostTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, Explainability: &DriftCheckExplainabilityProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelDataQuality: &DriftCheckModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelQuality: &DriftCheckModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, }, InferenceSpecification: &InferenceSpecificationProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, // the properties below are optional SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }, LastModifiedTime: jsii.String("lastModifiedTime"), MetadataProperties: &MetadataPropertiesProperty{ CommitId: jsii.String("commitId"), GeneratedBy: jsii.String("generatedBy"), ProjectId: jsii.String("projectId"), Repository: jsii.String("repository"), }, ModelApprovalStatus: jsii.String("modelApprovalStatus"), ModelCard: &ModelCardProperty{ ModelCardContent: jsii.String("modelCardContent"), ModelCardStatus: jsii.String("modelCardStatus"), }, ModelMetrics: &ModelMetricsProperty{ Bias: &BiasProperty{ PostTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, Explainability: &ExplainabilityProperty{ Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelDataQuality: &ModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelQuality: &ModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, }, ModelPackageDescription: jsii.String("modelPackageDescription"), ModelPackageGroupName: jsii.String("modelPackageGroupName"), ModelPackageName: jsii.String("modelPackageName"), ModelPackageStatusDetails: &ModelPackageStatusDetailsProperty{ ValidationStatuses: []interface{}{ &ModelPackageStatusItemProperty{ Name: jsii.String("name"), Status: jsii.String("status"), // the properties below are optional FailureReason: jsii.String("failureReason"), }, }, }, ModelPackageVersion: jsii.Number(123), SamplePayloadUrl: jsii.String("samplePayloadUrl"), SecurityConfig: &SecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, SkipModelValidation: jsii.String("skipModelValidation"), SourceAlgorithmSpecification: &SourceAlgorithmSpecificationProperty{ SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, }, SourceUri: jsii.String("sourceUri"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Task: jsii.String("task"), ValidationSpecification: &ValidationSpecificationProperty{ ValidationProfiles: []interface{}{ &ValidationProfileProperty{ ProfileName: jsii.String("profileName"), TransformJobDefinition: &TransformJobDefinitionProperty{ TransformInput: &TransformInputProperty{ DataSource: &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }, // the properties below are optional CompressionType: jsii.String("compressionType"), ContentType: jsii.String("contentType"), SplitType: jsii.String("splitType"), }, TransformOutput: &TransformOutputProperty{ S3OutputPath: jsii.String("s3OutputPath"), // the properties below are optional Accept: jsii.String("accept"), AssembleWith: jsii.String("assembleWith"), KmsKeyId: jsii.String("kmsKeyId"), }, TransformResources: &TransformResourcesProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, // the properties below are optional BatchStrategy: jsii.String("batchStrategy"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, MaxConcurrentTransforms: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), }, }, }, ValidationRole: jsii.String("validationRole"), }, })
func NewCfnModelPackage ¶ added in v2.45.0
func NewCfnModelPackage(scope constructs.Construct, id *string, props *CfnModelPackageProps) CfnModelPackage
type CfnModelPackageGroup ¶
type CfnModelPackageGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time when the model group was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the model group. AttrModelPackageGroupArn() *string // The status of the model group. AttrModelPackageGroupStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The description for the model group. ModelPackageGroupDescription() *string SetModelPackageGroupDescription(val *string) // The name of the model group. ModelPackageGroupName() *string SetModelPackageGroupName(val *string) // A resouce policy to control access to a model group. ModelPackageGroupPolicy() interface{} SetModelPackageGroupPolicy(val interface{}) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A group of versioned models in the model registry.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelPackageGroupPolicy interface{} cfnModelPackageGroup := awscdk.Aws_sagemaker.NewCfnModelPackageGroup(this, jsii.String("MyCfnModelPackageGroup"), &CfnModelPackageGroupProps{ ModelPackageGroupName: jsii.String("modelPackageGroupName"), // the properties below are optional ModelPackageGroupDescription: jsii.String("modelPackageGroupDescription"), ModelPackageGroupPolicy: modelPackageGroupPolicy, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnModelPackageGroup ¶
func NewCfnModelPackageGroup(scope constructs.Construct, id *string, props *CfnModelPackageGroupProps) CfnModelPackageGroup
type CfnModelPackageGroupProps ¶
type CfnModelPackageGroupProps struct { // The name of the model group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackagegroup.html#cfn-sagemaker-modelpackagegroup-modelpackagegroupname // ModelPackageGroupName *string `field:"required" json:"modelPackageGroupName" yaml:"modelPackageGroupName"` // The description for the model group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackagegroup.html#cfn-sagemaker-modelpackagegroup-modelpackagegroupdescription // ModelPackageGroupDescription *string `field:"optional" json:"modelPackageGroupDescription" yaml:"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.* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackagegroup.html#cfn-sagemaker-modelpackagegroup-modelpackagegrouppolicy // ModelPackageGroupPolicy interface{} `field:"optional" json:"modelPackageGroupPolicy" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackagegroup.html#cfn-sagemaker-modelpackagegroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnModelPackageGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelPackageGroupPolicy interface{} cfnModelPackageGroupProps := &CfnModelPackageGroupProps{ ModelPackageGroupName: jsii.String("modelPackageGroupName"), // the properties below are optional ModelPackageGroupDescription: jsii.String("modelPackageGroupDescription"), ModelPackageGroupPolicy: modelPackageGroupPolicy, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnModelPackageProps ¶ added in v2.45.0
type CfnModelPackageProps struct { // An array of additional Inference Specification objects. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-additionalinferencespecifications // AdditionalInferenceSpecifications interface{} `field:"optional" json:"additionalInferenceSpecifications" yaml:"additionalInferenceSpecifications"` // An array of additional Inference Specification objects to be added to the existing array. // // The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-additionalinferencespecificationstoadd // AdditionalInferenceSpecificationsToAdd interface{} `field:"optional" json:"additionalInferenceSpecificationsToAdd" yaml:"additionalInferenceSpecificationsToAdd"` // A description provided when the model approval is set. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-approvaldescription // ApprovalDescription *string `field:"optional" json:"approvalDescription" yaml:"approvalDescription"` // Whether the model package is to be certified to be listed on AWS Marketplace. // // For information about listing model packages on AWS Marketplace, see [List Your Algorithm or Model Package on AWS Marketplace](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-certifyformarketplace // CertifyForMarketplace interface{} `field:"optional" json:"certifyForMarketplace" yaml:"certifyForMarketplace"` // A unique token that guarantees that the call to this API is idempotent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-clienttoken // ClientToken *string `field:"optional" json:"clientToken" yaml:"clientToken"` // The metadata properties for the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-customermetadataproperties // CustomerMetadataProperties interface{} `field:"optional" json:"customerMetadataProperties" yaml:"customerMetadataProperties"` // The machine learning domain of your model package and its components. // // Common machine learning domains include computer vision and natural language processing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-domain // Domain *string `field:"optional" json:"domain" yaml:"domain"` // Represents the drift check baselines that can be used when the model monitor is set using the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-driftcheckbaselines // DriftCheckBaselines interface{} `field:"optional" json:"driftCheckBaselines" yaml:"driftCheckBaselines"` // Defines how to perform inference generation after a training job is run. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-inferencespecification // InferenceSpecification interface{} `field:"optional" json:"inferenceSpecification" yaml:"inferenceSpecification"` // The last time the model package was modified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-lastmodifiedtime // LastModifiedTime *string `field:"optional" json:"lastModifiedTime" yaml:"lastModifiedTime"` // Metadata properties of the tracking entity, trial, or trial component. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-metadataproperties // MetadataProperties interface{} `field:"optional" json:"metadataProperties" yaml:"metadataProperties"` // The approval status of the model. This can be one of the following values. // // - `APPROVED` - The model is approved // - `REJECTED` - The model is rejected. // - `PENDING_MANUAL_APPROVAL` - The model is waiting for manual approval. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelapprovalstatus // ModelApprovalStatus *string `field:"optional" json:"modelApprovalStatus" yaml:"modelApprovalStatus"` // An Amazon SageMaker Model Card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelcard // ModelCard interface{} `field:"optional" json:"modelCard" yaml:"modelCard"` // Metrics for the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelmetrics // ModelMetrics interface{} `field:"optional" json:"modelMetrics" yaml:"modelMetrics"` // The description of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagedescription // ModelPackageDescription *string `field:"optional" json:"modelPackageDescription" yaml:"modelPackageDescription"` // The model group to which the model belongs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagegroupname // ModelPackageGroupName *string `field:"optional" json:"modelPackageGroupName" yaml:"modelPackageGroupName"` // The name of the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagename // ModelPackageName *string `field:"optional" json:"modelPackageName" yaml:"modelPackageName"` // Specifies the validation and image scan statuses of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagestatusdetails // ModelPackageStatusDetails interface{} `field:"optional" json:"modelPackageStatusDetails" yaml:"modelPackageStatusDetails"` // The version number of a versioned model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackageversion // ModelPackageVersion *float64 `field:"optional" json:"modelPackageVersion" yaml:"modelPackageVersion"` // The Amazon Simple Storage Service path where the sample payload are stored. // // This path must point to a single gzip compressed tar archive (.tar.gz suffix). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-samplepayloadurl // SamplePayloadUrl *string `field:"optional" json:"samplePayloadUrl" yaml:"samplePayloadUrl"` // An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-securityconfig // SecurityConfig interface{} `field:"optional" json:"securityConfig" yaml:"securityConfig"` // Indicates if you want to skip model validation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-skipmodelvalidation // SkipModelValidation *string `field:"optional" json:"skipModelValidation" yaml:"skipModelValidation"` // A list of algorithms that were used to create a model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-sourcealgorithmspecification // SourceAlgorithmSpecification interface{} `field:"optional" json:"sourceAlgorithmSpecification" yaml:"sourceAlgorithmSpecification"` // The URI of the source for the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-sourceuri // SourceUri *string `field:"optional" json:"sourceUri" yaml:"sourceUri"` // A list of the tags associated with the model package. // // For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The machine learning task your model package accomplishes. // // Common machine learning tasks include object detection and image classification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-task // Task *string `field:"optional" json:"task" yaml:"task"` // Specifies batch transform jobs that SageMaker runs to validate your model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-validationspecification // ValidationSpecification interface{} `field:"optional" json:"validationSpecification" yaml:"validationSpecification"` }
Properties for defining a `CfnModelPackage`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelInput interface{} cfnModelPackageProps := &CfnModelPackageProps{ AdditionalInferenceSpecifications: []interface{}{ &AdditionalInferenceSpecificationDefinitionProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }, }, AdditionalInferenceSpecificationsToAdd: []interface{}{ &AdditionalInferenceSpecificationDefinitionProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }, }, ApprovalDescription: jsii.String("approvalDescription"), CertifyForMarketplace: jsii.Boolean(false), ClientToken: jsii.String("clientToken"), CustomerMetadataProperties: map[string]*string{ "customerMetadataPropertiesKey": jsii.String("customerMetadataProperties"), }, Domain: jsii.String("domain"), DriftCheckBaselines: &DriftCheckBaselinesProperty{ Bias: &DriftCheckBiasProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, PostTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, Explainability: &DriftCheckExplainabilityProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelDataQuality: &DriftCheckModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelQuality: &DriftCheckModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, }, InferenceSpecification: &InferenceSpecificationProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, // the properties below are optional SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }, LastModifiedTime: jsii.String("lastModifiedTime"), MetadataProperties: &MetadataPropertiesProperty{ CommitId: jsii.String("commitId"), GeneratedBy: jsii.String("generatedBy"), ProjectId: jsii.String("projectId"), Repository: jsii.String("repository"), }, ModelApprovalStatus: jsii.String("modelApprovalStatus"), ModelCard: &ModelCardProperty{ ModelCardContent: jsii.String("modelCardContent"), ModelCardStatus: jsii.String("modelCardStatus"), }, ModelMetrics: &ModelMetricsProperty{ Bias: &BiasProperty{ PostTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, Explainability: &ExplainabilityProperty{ Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelDataQuality: &ModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelQuality: &ModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, }, ModelPackageDescription: jsii.String("modelPackageDescription"), ModelPackageGroupName: jsii.String("modelPackageGroupName"), ModelPackageName: jsii.String("modelPackageName"), ModelPackageStatusDetails: &ModelPackageStatusDetailsProperty{ ValidationStatuses: []interface{}{ &ModelPackageStatusItemProperty{ Name: jsii.String("name"), Status: jsii.String("status"), // the properties below are optional FailureReason: jsii.String("failureReason"), }, }, }, ModelPackageVersion: jsii.Number(123), SamplePayloadUrl: jsii.String("samplePayloadUrl"), SecurityConfig: &SecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, SkipModelValidation: jsii.String("skipModelValidation"), SourceAlgorithmSpecification: &SourceAlgorithmSpecificationProperty{ SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, }, SourceUri: jsii.String("sourceUri"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, Task: jsii.String("task"), ValidationSpecification: &ValidationSpecificationProperty{ ValidationProfiles: []interface{}{ &ValidationProfileProperty{ ProfileName: jsii.String("profileName"), TransformJobDefinition: &TransformJobDefinitionProperty{ TransformInput: &TransformInputProperty{ DataSource: &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }, // the properties below are optional CompressionType: jsii.String("compressionType"), ContentType: jsii.String("contentType"), SplitType: jsii.String("splitType"), }, TransformOutput: &TransformOutputProperty{ S3OutputPath: jsii.String("s3OutputPath"), // the properties below are optional Accept: jsii.String("accept"), AssembleWith: jsii.String("assembleWith"), KmsKeyId: jsii.String("kmsKeyId"), }, TransformResources: &TransformResourcesProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, // the properties below are optional BatchStrategy: jsii.String("batchStrategy"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, MaxConcurrentTransforms: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), }, }, }, ValidationRole: jsii.String("validationRole"), }, }
type CfnModelPackage_AdditionalInferenceSpecificationDefinitionProperty ¶ added in v2.45.0
type CfnModelPackage_AdditionalInferenceSpecificationDefinitionProperty struct { // The Amazon ECR registry path of the Docker image that contains the inference code. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-containers // Containers interface{} `field:"required" json:"containers" yaml:"containers"` // A unique name to identify the additional inference specification. // // The name must be unique within the list of your additional inference specifications for a particular model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-name // Name *string `field:"required" json:"name" yaml:"name"` // A description of the additional Inference specification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-description // Description *string `field:"optional" json:"description" yaml:"description"` // The supported MIME types for the input data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-supportedcontenttypes // SupportedContentTypes *[]*string `field:"optional" json:"supportedContentTypes" yaml:"supportedContentTypes"` // A list of the instance types that are used to generate inferences in real-time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-supportedrealtimeinferenceinstancetypes // SupportedRealtimeInferenceInstanceTypes *[]*string `field:"optional" json:"supportedRealtimeInferenceInstanceTypes" yaml:"supportedRealtimeInferenceInstanceTypes"` // The supported MIME types for the output data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-supportedresponsemimetypes // SupportedResponseMimeTypes *[]*string `field:"optional" json:"supportedResponseMimeTypes" yaml:"supportedResponseMimeTypes"` // A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition-supportedtransforminstancetypes // SupportedTransformInstanceTypes *[]*string `field:"optional" json:"supportedTransformInstanceTypes" yaml:"supportedTransformInstanceTypes"` }
A structure of additional Inference Specification.
Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelInput interface{} additionalInferenceSpecificationDefinitionProperty := &AdditionalInferenceSpecificationDefinitionProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }
type CfnModelPackage_BiasProperty ¶ added in v2.45.0
type CfnModelPackage_BiasProperty struct { // The post-training bias report for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-bias.html#cfn-sagemaker-modelpackage-bias-posttrainingreport // PostTrainingReport interface{} `field:"optional" json:"postTrainingReport" yaml:"postTrainingReport"` // The pre-training bias report for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-bias.html#cfn-sagemaker-modelpackage-bias-pretrainingreport // PreTrainingReport interface{} `field:"optional" json:"preTrainingReport" yaml:"preTrainingReport"` // The bias report for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-bias.html#cfn-sagemaker-modelpackage-bias-report // Report interface{} `field:"optional" json:"report" yaml:"report"` }
Contains bias metrics for a model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" biasProperty := &BiasProperty{ PostTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_DataSourceProperty ¶ added in v2.45.0
type CfnModelPackage_DataSourceProperty struct { // The S3 location of the data source that is associated with a channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-datasource.html#cfn-sagemaker-modelpackage-datasource-s3datasource // S3DataSource interface{} `field:"required" json:"s3DataSource" yaml:"s3DataSource"` }
Describes the location of the channel data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataSourceProperty := &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }
type CfnModelPackage_DriftCheckBaselinesProperty ¶ added in v2.45.0
type CfnModelPackage_DriftCheckBaselinesProperty struct { // Represents the drift check bias baselines that can be used when the model monitor is set using the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbaselines.html#cfn-sagemaker-modelpackage-driftcheckbaselines-bias // Bias interface{} `field:"optional" json:"bias" yaml:"bias"` // Represents the drift check explainability baselines that can be used when the model monitor is set using the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbaselines.html#cfn-sagemaker-modelpackage-driftcheckbaselines-explainability // Explainability interface{} `field:"optional" json:"explainability" yaml:"explainability"` // Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbaselines.html#cfn-sagemaker-modelpackage-driftcheckbaselines-modeldataquality // ModelDataQuality interface{} `field:"optional" json:"modelDataQuality" yaml:"modelDataQuality"` // Represents the drift check model quality baselines that can be used when the model monitor is set using the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbaselines.html#cfn-sagemaker-modelpackage-driftcheckbaselines-modelquality // ModelQuality interface{} `field:"optional" json:"modelQuality" yaml:"modelQuality"` }
Represents the drift check baselines that can be used when the model monitor is set using the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" driftCheckBaselinesProperty := &DriftCheckBaselinesProperty{ Bias: &DriftCheckBiasProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, PostTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, Explainability: &DriftCheckExplainabilityProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelDataQuality: &DriftCheckModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelQuality: &DriftCheckModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, }
type CfnModelPackage_DriftCheckBiasProperty ¶ added in v2.45.0
type CfnModelPackage_DriftCheckBiasProperty struct { // The bias config file for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbias.html#cfn-sagemaker-modelpackage-driftcheckbias-configfile // ConfigFile interface{} `field:"optional" json:"configFile" yaml:"configFile"` // The post-training constraints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbias.html#cfn-sagemaker-modelpackage-driftcheckbias-posttrainingconstraints // PostTrainingConstraints interface{} `field:"optional" json:"postTrainingConstraints" yaml:"postTrainingConstraints"` // The pre-training constraints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbias.html#cfn-sagemaker-modelpackage-driftcheckbias-pretrainingconstraints // PreTrainingConstraints interface{} `field:"optional" json:"preTrainingConstraints" yaml:"preTrainingConstraints"` }
Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" driftCheckBiasProperty := &DriftCheckBiasProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, PostTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingConstraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_DriftCheckExplainabilityProperty ¶ added in v2.45.0
type CfnModelPackage_DriftCheckExplainabilityProperty struct { // The explainability config file for the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckexplainability.html#cfn-sagemaker-modelpackage-driftcheckexplainability-configfile // ConfigFile interface{} `field:"optional" json:"configFile" yaml:"configFile"` // The drift check explainability constraints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckexplainability.html#cfn-sagemaker-modelpackage-driftcheckexplainability-constraints // Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"` }
Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" driftCheckExplainabilityProperty := &DriftCheckExplainabilityProperty{ ConfigFile: &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }, Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_DriftCheckModelDataQualityProperty ¶ added in v2.45.0
type CfnModelPackage_DriftCheckModelDataQualityProperty struct { // The drift check model data quality constraints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodeldataquality.html#cfn-sagemaker-modelpackage-driftcheckmodeldataquality-constraints // Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"` // The drift check model data quality statistics. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodeldataquality.html#cfn-sagemaker-modelpackage-driftcheckmodeldataquality-statistics // Statistics interface{} `field:"optional" json:"statistics" yaml:"statistics"` }
Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" driftCheckModelDataQualityProperty := &DriftCheckModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_DriftCheckModelQualityProperty ¶ added in v2.45.0
type CfnModelPackage_DriftCheckModelQualityProperty struct { // The drift check model quality constraints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodelquality.html#cfn-sagemaker-modelpackage-driftcheckmodelquality-constraints // Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"` // The drift check model quality statistics. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodelquality.html#cfn-sagemaker-modelpackage-driftcheckmodelquality-statistics // Statistics interface{} `field:"optional" json:"statistics" yaml:"statistics"` }
Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" driftCheckModelQualityProperty := &DriftCheckModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_ExplainabilityProperty ¶ added in v2.45.0
type CfnModelPackage_ExplainabilityProperty struct { // The explainability report for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-explainability.html#cfn-sagemaker-modelpackage-explainability-report // Report interface{} `field:"optional" json:"report" yaml:"report"` }
Contains explainability metrics for a model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" explainabilityProperty := &ExplainabilityProperty{ Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_FileSourceProperty ¶ added in v2.45.0
type CfnModelPackage_FileSourceProperty struct { // The Amazon S3 URI for the file source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html#cfn-sagemaker-modelpackage-filesource-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // The digest of the file source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html#cfn-sagemaker-modelpackage-filesource-contentdigest // ContentDigest *string `field:"optional" json:"contentDigest" yaml:"contentDigest"` // The type of content stored in the file source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html#cfn-sagemaker-modelpackage-filesource-contenttype // ContentType *string `field:"optional" json:"contentType" yaml:"contentType"` }
Contains details regarding the file source.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fileSourceProperty := &FileSourceProperty{ S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), ContentType: jsii.String("contentType"), }
type CfnModelPackage_InferenceSpecificationProperty ¶ added in v2.45.0
type CfnModelPackage_InferenceSpecificationProperty struct { // The Amazon ECR registry path of the Docker image that contains the inference code. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html#cfn-sagemaker-modelpackage-inferencespecification-containers // Containers interface{} `field:"required" json:"containers" yaml:"containers"` // The supported MIME types for the input data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html#cfn-sagemaker-modelpackage-inferencespecification-supportedcontenttypes // SupportedContentTypes *[]*string `field:"required" json:"supportedContentTypes" yaml:"supportedContentTypes"` // The supported MIME types for the output data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html#cfn-sagemaker-modelpackage-inferencespecification-supportedresponsemimetypes // SupportedResponseMimeTypes *[]*string `field:"required" json:"supportedResponseMimeTypes" yaml:"supportedResponseMimeTypes"` // A list of the instance types that are used to generate inferences in real-time. // // This parameter is required for unversioned models, and optional for versioned models. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html#cfn-sagemaker-modelpackage-inferencespecification-supportedrealtimeinferenceinstancetypes // SupportedRealtimeInferenceInstanceTypes *[]*string `field:"optional" json:"supportedRealtimeInferenceInstanceTypes" yaml:"supportedRealtimeInferenceInstanceTypes"` // A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. // // This parameter is required for unversioned models, and optional for versioned models. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html#cfn-sagemaker-modelpackage-inferencespecification-supportedtransforminstancetypes // SupportedTransformInstanceTypes *[]*string `field:"optional" json:"supportedTransformInstanceTypes" yaml:"supportedTransformInstanceTypes"` }
Defines how to perform inference generation after a training job is run.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelInput interface{} inferenceSpecificationProperty := &InferenceSpecificationProperty{ Containers: []interface{}{ &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }, }, SupportedContentTypes: []*string{ jsii.String("supportedContentTypes"), }, SupportedResponseMimeTypes: []*string{ jsii.String("supportedResponseMimeTypes"), }, // the properties below are optional SupportedRealtimeInferenceInstanceTypes: []*string{ jsii.String("supportedRealtimeInferenceInstanceTypes"), }, SupportedTransformInstanceTypes: []*string{ jsii.String("supportedTransformInstanceTypes"), }, }
type CfnModelPackage_MetadataPropertiesProperty ¶ added in v2.45.0
type CfnModelPackage_MetadataPropertiesProperty struct { // The commit ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metadataproperties.html#cfn-sagemaker-modelpackage-metadataproperties-commitid // CommitId *string `field:"optional" json:"commitId" yaml:"commitId"` // The entity this entity was generated by. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metadataproperties.html#cfn-sagemaker-modelpackage-metadataproperties-generatedby // GeneratedBy *string `field:"optional" json:"generatedBy" yaml:"generatedBy"` // The project ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metadataproperties.html#cfn-sagemaker-modelpackage-metadataproperties-projectid // ProjectId *string `field:"optional" json:"projectId" yaml:"projectId"` // The repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metadataproperties.html#cfn-sagemaker-modelpackage-metadataproperties-repository // Repository *string `field:"optional" json:"repository" yaml:"repository"` }
Metadata properties of the tracking entity, trial, or trial component.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metadataPropertiesProperty := &MetadataPropertiesProperty{ CommitId: jsii.String("commitId"), GeneratedBy: jsii.String("generatedBy"), ProjectId: jsii.String("projectId"), Repository: jsii.String("repository"), }
type CfnModelPackage_MetricsSourceProperty ¶ added in v2.45.0
type CfnModelPackage_MetricsSourceProperty struct { // The metric source content type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html#cfn-sagemaker-modelpackage-metricssource-contenttype // ContentType *string `field:"required" json:"contentType" yaml:"contentType"` // The S3 URI for the metrics source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html#cfn-sagemaker-modelpackage-metricssource-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // The hash key used for the metrics source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html#cfn-sagemaker-modelpackage-metricssource-contentdigest // ContentDigest *string `field:"optional" json:"contentDigest" yaml:"contentDigest"` }
Details about the metrics source.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metricsSourceProperty := &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }
type CfnModelPackage_ModelAccessConfigProperty ¶ added in v2.154.0
type CfnModelPackage_ModelAccessConfigProperty struct { // Specifies agreement to the model end-user license agreement (EULA). // // The `AcceptEula` value must be explicitly defined as `True` in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelaccessconfig.html#cfn-sagemaker-modelpackage-modelaccessconfig-accepteula // AcceptEula interface{} `field:"required" json:"acceptEula" yaml:"acceptEula"` }
The access configuration file to control access to the ML model.
You can explicitly accept the model end-user license agreement (EULA) within the `ModelAccessConfig` .
- If you are a Jumpstart user, see the [End-user license agreements](https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula) section for more details on accepting the EULA. - If you are an AutoML user, see the *Optional Parameters* section of *Create an AutoML job to fine-tune text generation models using the API* for details on [How to set the EULA acceptance when fine-tuning a model using the AutoML API](https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelAccessConfigProperty := &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }
type CfnModelPackage_ModelCardProperty ¶ added in v2.154.0
type CfnModelPackage_ModelCardProperty struct { // The content of the model card. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelcard.html#cfn-sagemaker-modelpackage-modelcard-modelcardcontent // ModelCardContent *string `field:"required" json:"modelCardContent" yaml:"modelCardContent"` // The approval status of the model card within your organization. // // Different organizations might have different criteria for model card review and approval. // // - `Draft` : The model card is a work in progress. // - `PendingReview` : The model card is pending review. // - `Approved` : The model card is approved. // - `Archived` : The model card is archived. No more updates should be made to the model card, but it can still be exported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelcard.html#cfn-sagemaker-modelpackage-modelcard-modelcardstatus // ModelCardStatus *string `field:"required" json:"modelCardStatus" yaml:"modelCardStatus"` }
An Amazon SageMaker Model Card.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelCardProperty := &ModelCardProperty{ ModelCardContent: jsii.String("modelCardContent"), ModelCardStatus: jsii.String("modelCardStatus"), }
type CfnModelPackage_ModelDataQualityProperty ¶ added in v2.45.0
type CfnModelPackage_ModelDataQualityProperty struct { // Data quality constraints for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modeldataquality.html#cfn-sagemaker-modelpackage-modeldataquality-constraints // Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"` // Data quality statistics for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modeldataquality.html#cfn-sagemaker-modelpackage-modeldataquality-statistics // Statistics interface{} `field:"optional" json:"statistics" yaml:"statistics"` }
Data quality constraints and statistics for a model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelDataQualityProperty := &ModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_ModelDataSourceProperty ¶ added in v2.154.0
type CfnModelPackage_ModelDataSourceProperty struct { // Specifies the S3 location of ML model data to deploy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modeldatasource.html#cfn-sagemaker-modelpackage-modeldatasource-s3datasource // S3DataSource interface{} `field:"optional" json:"s3DataSource" yaml:"s3DataSource"` }
Specifies the location of ML model data to deploy.
If specified, you must specify one and only one of the available data sources.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelDataSourceProperty := &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }
type CfnModelPackage_ModelInputProperty ¶ added in v2.55.0
type CfnModelPackage_ModelInputProperty struct { // The input configuration object for the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelinput.html#cfn-sagemaker-modelpackage-modelinput-datainputconfig // DataInputConfig *string `field:"required" json:"dataInputConfig" yaml:"dataInputConfig"` }
Input object for the model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelInputProperty := &ModelInputProperty{ DataInputConfig: jsii.String("dataInputConfig"), }
type CfnModelPackage_ModelMetricsProperty ¶ added in v2.45.0
type CfnModelPackage_ModelMetricsProperty struct { // Metrics that measure bias in a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-bias // Bias interface{} `field:"optional" json:"bias" yaml:"bias"` // Metrics that help explain a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-explainability // Explainability interface{} `field:"optional" json:"explainability" yaml:"explainability"` // Metrics that measure the quality of the input data for a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-modeldataquality // ModelDataQuality interface{} `field:"optional" json:"modelDataQuality" yaml:"modelDataQuality"` // Metrics that measure the quality of a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html#cfn-sagemaker-modelpackage-modelmetrics-modelquality // ModelQuality interface{} `field:"optional" json:"modelQuality" yaml:"modelQuality"` }
Contains metrics captured from a model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelMetricsProperty := &ModelMetricsProperty{ Bias: &BiasProperty{ PostTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, PreTrainingReport: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, Explainability: &ExplainabilityProperty{ Report: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelDataQuality: &ModelDataQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, ModelQuality: &ModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }, }
type CfnModelPackage_ModelPackageContainerDefinitionProperty ¶ added in v2.45.0
type CfnModelPackage_ModelPackageContainerDefinitionProperty struct { // The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. // // If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-image // Image *string `field:"required" json:"image" yaml:"image"` // The DNS host name for the Docker container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-containerhostname // ContainerHostname *string `field:"optional" json:"containerHostname" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // The machine learning framework of the model package container image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-framework // Framework *string `field:"optional" json:"framework" yaml:"framework"` // The framework version of the Model Package Container Image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-frameworkversion // FrameworkVersion *string `field:"optional" json:"frameworkVersion" yaml:"frameworkVersion"` // An MD5 hash of the training algorithm that identifies the Docker image used for training. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-imagedigest // ImageDigest *string `field:"optional" json:"imageDigest" yaml:"imageDigest"` // Specifies the location of ML model data to deploy during endpoint creation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-modeldatasource // ModelDataSource interface{} `field:"optional" json:"modelDataSource" yaml:"modelDataSource"` // The Amazon 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 model artifacts must be in an S3 bucket that is in the same region as the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-modeldataurl // ModelDataUrl *string `field:"optional" json:"modelDataUrl" yaml:"modelDataUrl"` // A structure with Model Input details. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-modelinput // ModelInput interface{} `field:"optional" json:"modelInput" yaml:"modelInput"` // The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. // // You can find a list of benchmarked models by calling `ListModelMetadata` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-nearestmodelname // NearestModelName *string `field:"optional" json:"nearestModelName" yaml:"nearestModelName"` }
Describes the Docker container for the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var modelInput interface{} modelPackageContainerDefinitionProperty := &ModelPackageContainerDefinitionProperty{ Image: jsii.String("image"), // the properties below are optional ContainerHostname: jsii.String("containerHostname"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, Framework: jsii.String("framework"), FrameworkVersion: jsii.String("frameworkVersion"), ImageDigest: jsii.String("imageDigest"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelInput: modelInput, NearestModelName: jsii.String("nearestModelName"), }
type CfnModelPackage_ModelPackageStatusDetailsProperty ¶ added in v2.45.0
type CfnModelPackage_ModelPackageStatusDetailsProperty struct { // The validation status of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusdetails.html#cfn-sagemaker-modelpackage-modelpackagestatusdetails-validationstatuses // ValidationStatuses interface{} `field:"optional" json:"validationStatuses" yaml:"validationStatuses"` }
Specifies the validation and image scan statuses of the model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelPackageStatusDetailsProperty := &ModelPackageStatusDetailsProperty{ ValidationStatuses: []interface{}{ &ModelPackageStatusItemProperty{ Name: jsii.String("name"), Status: jsii.String("status"), // the properties below are optional FailureReason: jsii.String("failureReason"), }, }, }
type CfnModelPackage_ModelPackageStatusItemProperty ¶ added in v2.45.0
type CfnModelPackage_ModelPackageStatusItemProperty struct { // The name of the model package for which the overall status is being reported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html#cfn-sagemaker-modelpackage-modelpackagestatusitem-name // Name *string `field:"required" json:"name" yaml:"name"` // The current status. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html#cfn-sagemaker-modelpackage-modelpackagestatusitem-status // Status *string `field:"required" json:"status" yaml:"status"` // if the overall status is `Failed` , the reason for the failure. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html#cfn-sagemaker-modelpackage-modelpackagestatusitem-failurereason // FailureReason *string `field:"optional" json:"failureReason" yaml:"failureReason"` }
Represents the overall status of a model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelPackageStatusItemProperty := &ModelPackageStatusItemProperty{ Name: jsii.String("name"), Status: jsii.String("status"), // the properties below are optional FailureReason: jsii.String("failureReason"), }
type CfnModelPackage_ModelQualityProperty ¶ added in v2.45.0
type CfnModelPackage_ModelQualityProperty struct { // Model quality constraints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelquality.html#cfn-sagemaker-modelpackage-modelquality-constraints // Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"` // Model quality statistics. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelquality.html#cfn-sagemaker-modelpackage-modelquality-statistics // Statistics interface{} `field:"optional" json:"statistics" yaml:"statistics"` }
Model quality statistics and constraints.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelQualityProperty := &ModelQualityProperty{ Constraints: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, Statistics: &MetricsSourceProperty{ ContentType: jsii.String("contentType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ContentDigest: jsii.String("contentDigest"), }, }
type CfnModelPackage_S3DataSourceProperty ¶ added in v2.45.0
type CfnModelPackage_S3DataSourceProperty struct { // If you choose `S3Prefix` , `S3Uri` identifies a key name prefix. // // SageMaker uses all objects that match the specified key name prefix for model training. // // If you choose `ManifestFile` , `S3Uri` identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training. // // If you choose `AugmentedManifestFile` , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. `AugmentedManifestFile` can only be used if the Channel's input mode is `Pipe` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3datasource.html#cfn-sagemaker-modelpackage-s3datasource-s3datatype // S3DataType *string `field:"required" json:"s3DataType" yaml:"s3DataType"` // Depending on the value specified for the `S3DataType` , identifies either a key name prefix or a manifest. // // For example: // // - A key name prefix might look like this: `s3://bucketname/exampleprefix/` // - A manifest might look like this: `s3://bucketname/example.manifest` // // A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of `S3Uri` . Note that the prefix must be a valid non-empty `S3Uri` that precludes users from specifying a manifest whose individual `S3Uri` is sourced from different S3 buckets. // // The following code example shows a valid manifest format: // // `[ {"prefix": "s3://customer_bucket/some/prefix/"},` // // `"relative/path/to/custdata-1",` // // `"relative/path/custdata-2",` // // `...` // // `"relative/path/custdata-N"` // // `]` // // This JSON is equivalent to the following `S3Uri` list: // // `s3://customer_bucket/some/prefix/relative/path/to/custdata-1` // // `s3://customer_bucket/some/prefix/relative/path/custdata-2` // // `...` // // `s3://customer_bucket/some/prefix/relative/path/custdata-N` // // The complete set of `S3Uri` in this manifest is the input data for the channel for this data source. The object that each `S3Uri` points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf. // // Your input bucket must be located in same AWS region as your training job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3datasource.html#cfn-sagemaker-modelpackage-s3datasource-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` }
Describes the S3 data source.
Your input bucket must be in the same AWS region as your training job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3DataSourceProperty := &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }
type CfnModelPackage_S3ModelDataSourceProperty ¶ added in v2.154.0
type CfnModelPackage_S3ModelDataSourceProperty struct { // Specifies how the ML model data is prepared. // // If you choose `Gzip` and choose `S3Object` as the value of `S3DataType` , `S3Uri` identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment. // // If you choose `None` and chooose `S3Object` as the value of `S3DataType` , `S3Uri` identifies an object that represents an uncompressed ML model to deploy. // // If you choose None and choose `S3Prefix` as the value of `S3DataType` , `S3Uri` identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy. // // If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code: // // - If you choose `S3Object` as the value of `S3DataType` , then SageMaker will split the key of the S3 object referenced by `S3Uri` by slash (/), and use the last part as the filename of the file holding the content of the S3 object. // - If you choose `S3Prefix` as the value of `S3DataType` , then for each S3 object under the key name pefix referenced by `S3Uri` , SageMaker will trim its key by the prefix, and use the remainder as the path (relative to `/opt/ml/model` ) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object. // - Do not use any of the following as file names or directory names: // // - An empty or blank string // - A string which contains null bytes // - A string longer than 255 bytes // - A single dot ( `.` ) // - A double dot ( `..` ) // - Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects `s3://mybucket/model/weights` and `s3://mybucket/model/weights/part1` and you specify `s3://mybucket/model/` as the value of `S3Uri` and `S3Prefix` as the value of `S3DataType` , then it will result in name clash between `/opt/ml/model/weights` (a regular file) and `/opt/ml/model/weights/` (a directory). // - Do not organize the model artifacts in [S3 console using folders](https://docs.aws.amazon.com//AmazonS3/latest/userguide/using-folders.html) . When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3modeldatasource.html#cfn-sagemaker-modelpackage-s3modeldatasource-compressiontype // CompressionType *string `field:"required" json:"compressionType" yaml:"compressionType"` // Specifies the type of ML model data to deploy. // // If you choose `S3Prefix` , `S3Uri` identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by `S3Uri` always ends with a forward slash (/). // // If you choose `S3Object` , `S3Uri` identifies an object that is the ML model data to deploy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3modeldatasource.html#cfn-sagemaker-modelpackage-s3modeldatasource-s3datatype // S3DataType *string `field:"required" json:"s3DataType" yaml:"s3DataType"` // Specifies the S3 path of ML model data to deploy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3modeldatasource.html#cfn-sagemaker-modelpackage-s3modeldatasource-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // Specifies the access configuration file for the ML model. // // You can explicitly accept the model end-user license agreement (EULA) within the `ModelAccessConfig` . You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3modeldatasource.html#cfn-sagemaker-modelpackage-s3modeldatasource-modelaccessconfig // ModelAccessConfig interface{} `field:"optional" json:"modelAccessConfig" yaml:"modelAccessConfig"` }
Specifies the S3 location of ML model data to deploy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3ModelDataSourceProperty := &S3ModelDataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }
type CfnModelPackage_SecurityConfigProperty ¶ added in v2.154.0
type CfnModelPackage_SecurityConfigProperty struct { // The AWS KMS Key ID (KMSKeyId) used for encryption of model package information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-securityconfig.html#cfn-sagemaker-modelpackage-securityconfig-kmskeyid // KmsKeyId *string `field:"required" json:"kmsKeyId" yaml:"kmsKeyId"` }
An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" securityConfigProperty := &SecurityConfigProperty{ KmsKeyId: jsii.String("kmsKeyId"), }
type CfnModelPackage_SourceAlgorithmProperty ¶ added in v2.45.0
type CfnModelPackage_SourceAlgorithmProperty struct { // The name of an algorithm that was used to create the model package. // // The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-sourcealgorithm.html#cfn-sagemaker-modelpackage-sourcealgorithm-algorithmname // AlgorithmName *string `field:"required" json:"algorithmName" yaml:"algorithmName"` // The Amazon 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 model artifacts must be in an S3 bucket that is in the same AWS region as the algorithm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-sourcealgorithm.html#cfn-sagemaker-modelpackage-sourcealgorithm-modeldataurl // ModelDataUrl *string `field:"optional" json:"modelDataUrl" yaml:"modelDataUrl"` }
Specifies an algorithm that was used to create the model package.
The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sourceAlgorithmProperty := &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }
type CfnModelPackage_SourceAlgorithmSpecificationProperty ¶ added in v2.45.0
type CfnModelPackage_SourceAlgorithmSpecificationProperty struct { // A list of the algorithms that were used to create a model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-sourcealgorithmspecification.html#cfn-sagemaker-modelpackage-sourcealgorithmspecification-sourcealgorithms // SourceAlgorithms interface{} `field:"required" json:"sourceAlgorithms" yaml:"sourceAlgorithms"` }
A list of algorithms that were used to create a model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sourceAlgorithmSpecificationProperty := &SourceAlgorithmSpecificationProperty{ SourceAlgorithms: []interface{}{ &SourceAlgorithmProperty{ AlgorithmName: jsii.String("algorithmName"), // the properties below are optional ModelDataUrl: jsii.String("modelDataUrl"), }, }, }
type CfnModelPackage_TransformInputProperty ¶ added in v2.45.0
type CfnModelPackage_TransformInputProperty struct { // Describes the location of the channel data, which is, the S3 location of the input data that the model can consume. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transforminput.html#cfn-sagemaker-modelpackage-transforminput-datasource // DataSource interface{} `field:"required" json:"dataSource" yaml:"dataSource"` // If your transform data is compressed, specify the compression type. // // Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is `None` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transforminput.html#cfn-sagemaker-modelpackage-transforminput-compressiontype // CompressionType *string `field:"optional" json:"compressionType" yaml:"compressionType"` // The multipurpose internet mail extension (MIME) type of the data. // // Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transforminput.html#cfn-sagemaker-modelpackage-transforminput-contenttype // ContentType *string `field:"optional" json:"contentType" yaml:"contentType"` // The method to use to split the transform job's data files into smaller batches. // // Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for `SplitType` is `None` , which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to `Line` to split records on a newline character boundary. `SplitType` also supports a number of record-oriented binary data formats. Currently, the supported record formats are: // // - RecordIO // - TFRecord // // When splitting is enabled, the size of a mini-batch depends on the values of the `BatchStrategy` and `MaxPayloadInMB` parameters. When the value of `BatchStrategy` is `MultiRecord` , Amazon SageMaker sends the maximum number of records in each request, up to the `MaxPayloadInMB` limit. If the value of `BatchStrategy` is `SingleRecord` , Amazon SageMaker sends individual records in each request. // // > Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of `BatchStrategy` is set to `SingleRecord` . Padding is not removed if the value of `BatchStrategy` is set to `MultiRecord` . // > // > For more information about `RecordIO` , see [Create a Dataset Using RecordIO](https://docs.aws.amazon.com/https://mxnet.apache.org/api/faq/recordio) in the MXNet documentation. For more information about `TFRecord` , see [Consuming TFRecord data](https://docs.aws.amazon.com/https://www.tensorflow.org/guide/data#consuming_tfrecord_data) in the TensorFlow documentation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transforminput.html#cfn-sagemaker-modelpackage-transforminput-splittype // SplitType *string `field:"optional" json:"splitType" yaml:"splitType"` }
Describes the input source of a transform job and the way the transform job consumes it.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" transformInputProperty := &TransformInputProperty{ DataSource: &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }, // the properties below are optional CompressionType: jsii.String("compressionType"), ContentType: jsii.String("contentType"), SplitType: jsii.String("splitType"), }
type CfnModelPackage_TransformJobDefinitionProperty ¶ added in v2.45.0
type CfnModelPackage_TransformJobDefinitionProperty struct { // A description of the input source and the way the transform job consumes it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-transforminput // TransformInput interface{} `field:"required" json:"transformInput" yaml:"transformInput"` // Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-transformoutput // TransformOutput interface{} `field:"required" json:"transformOutput" yaml:"transformOutput"` // Identifies the ML compute instances for the transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-transformresources // TransformResources interface{} `field:"required" json:"transformResources" yaml:"transformResources"` // A string that determines the number of records included in a single mini-batch. // // `SingleRecord` means only one record is used per mini-batch. `MultiRecord` means a mini-batch is set to contain as many records that can fit within the `MaxPayloadInMB` limit. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-batchstrategy // BatchStrategy *string `field:"optional" json:"batchStrategy" yaml:"batchStrategy"` // The environment variables to set in the Docker container. // // We support up to 16 key and values entries in the map. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // The maximum number of parallel requests that can be sent to each instance in a transform job. // // The default value is 1. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-maxconcurrenttransforms // MaxConcurrentTransforms *float64 `field:"optional" json:"maxConcurrentTransforms" yaml:"maxConcurrentTransforms"` // The maximum payload size allowed, in MB. // // A payload is the data portion of a record (without metadata). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-maxpayloadinmb // MaxPayloadInMb *float64 `field:"optional" json:"maxPayloadInMb" yaml:"maxPayloadInMb"` }
Defines the input needed to run a transform job using the inference specification specified in the algorithm.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" transformJobDefinitionProperty := &TransformJobDefinitionProperty{ TransformInput: &TransformInputProperty{ DataSource: &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }, // the properties below are optional CompressionType: jsii.String("compressionType"), ContentType: jsii.String("contentType"), SplitType: jsii.String("splitType"), }, TransformOutput: &TransformOutputProperty{ S3OutputPath: jsii.String("s3OutputPath"), // the properties below are optional Accept: jsii.String("accept"), AssembleWith: jsii.String("assembleWith"), KmsKeyId: jsii.String("kmsKeyId"), }, TransformResources: &TransformResourcesProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, // the properties below are optional BatchStrategy: jsii.String("batchStrategy"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, MaxConcurrentTransforms: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), }
type CfnModelPackage_TransformOutputProperty ¶ added in v2.45.0
type CfnModelPackage_TransformOutputProperty struct { // The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. // // For example, `s3://bucket-name/key-name-prefix` . // // For every S3 object used as input for the transform job, batch transform stores the transformed data with an . `out` suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at `s3://bucket-name/input-name-prefix/dataset01/data.csv` , batch transform stores the transformed data at `s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out` . Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an . `out` file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-s3outputpath // S3OutputPath *string `field:"required" json:"s3OutputPath" yaml:"s3OutputPath"` // The MIME type used to specify the output data. // // Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-accept // Accept *string `field:"optional" json:"accept" yaml:"accept"` // Defines how to assemble the results of the transform job as a single S3 object. // // Choose a format that is most convenient to you. To concatenate the results in binary format, specify `None` . To add a newline character at the end of every transformed record, specify `Line` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-assemblewith // AssembleWith *string `field:"optional" json:"assembleWith" yaml:"assembleWith"` // 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. // // 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](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the *AWS Key Management Service Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformoutput.html#cfn-sagemaker-modelpackage-transformoutput-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
Describes the results of a transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" transformOutputProperty := &TransformOutputProperty{ S3OutputPath: jsii.String("s3OutputPath"), // the properties below are optional Accept: jsii.String("accept"), AssembleWith: jsii.String("assembleWith"), KmsKeyId: jsii.String("kmsKeyId"), }
type CfnModelPackage_TransformResourcesProperty ¶ added in v2.45.0
type CfnModelPackage_TransformResourcesProperty struct { // The number of ML compute instances to use in the transform job. // // The default value is `1` , and the maximum is `100` . For distributed transform jobs, specify a value greater than `1` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformresources.html#cfn-sagemaker-modelpackage-transformresources-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The ML compute instance type for the transform job. // // If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or `ml.m5.large` instance types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformresources.html#cfn-sagemaker-modelpackage-transformresources-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. // // > 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 `VolumeKmsKeyId` when using an instance type with local storage. // > // > 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) . // // The `VolumeKmsKeyId` 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`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformresources.html#cfn-sagemaker-modelpackage-transformresources-volumekmskeyid // VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"` }
Describes the resources, including ML instance types and ML instance count, to use for transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" transformResourcesProperty := &TransformResourcesProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }
type CfnModelPackage_ValidationProfileProperty ¶ added in v2.45.0
type CfnModelPackage_ValidationProfileProperty struct { // The name of the profile for the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-validationprofile.html#cfn-sagemaker-modelpackage-validationprofile-profilename // ProfileName *string `field:"required" json:"profileName" yaml:"profileName"` // The `TransformJobDefinition` object that describes the transform job used for the validation of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-validationprofile.html#cfn-sagemaker-modelpackage-validationprofile-transformjobdefinition // TransformJobDefinition interface{} `field:"required" json:"transformJobDefinition" yaml:"transformJobDefinition"` }
Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" validationProfileProperty := &ValidationProfileProperty{ ProfileName: jsii.String("profileName"), TransformJobDefinition: &TransformJobDefinitionProperty{ TransformInput: &TransformInputProperty{ DataSource: &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }, // the properties below are optional CompressionType: jsii.String("compressionType"), ContentType: jsii.String("contentType"), SplitType: jsii.String("splitType"), }, TransformOutput: &TransformOutputProperty{ S3OutputPath: jsii.String("s3OutputPath"), // the properties below are optional Accept: jsii.String("accept"), AssembleWith: jsii.String("assembleWith"), KmsKeyId: jsii.String("kmsKeyId"), }, TransformResources: &TransformResourcesProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, // the properties below are optional BatchStrategy: jsii.String("batchStrategy"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, MaxConcurrentTransforms: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), }, }
type CfnModelPackage_ValidationSpecificationProperty ¶ added in v2.45.0
type CfnModelPackage_ValidationSpecificationProperty struct { // An array of `ModelPackageValidationProfile` objects, each of which specifies a batch transform job that SageMaker runs to validate your model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-validationspecification.html#cfn-sagemaker-modelpackage-validationspecification-validationprofiles // ValidationProfiles interface{} `field:"required" json:"validationProfiles" yaml:"validationProfiles"` // The IAM roles to be used for the validation of the model package. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-validationspecification.html#cfn-sagemaker-modelpackage-validationspecification-validationrole // ValidationRole *string `field:"required" json:"validationRole" yaml:"validationRole"` }
Specifies batch transform jobs that SageMaker runs to validate your model package.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" validationSpecificationProperty := &ValidationSpecificationProperty{ ValidationProfiles: []interface{}{ &ValidationProfileProperty{ ProfileName: jsii.String("profileName"), TransformJobDefinition: &TransformJobDefinitionProperty{ TransformInput: &TransformInputProperty{ DataSource: &DataSourceProperty{ S3DataSource: &S3DataSourceProperty{ S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), }, }, // the properties below are optional CompressionType: jsii.String("compressionType"), ContentType: jsii.String("contentType"), SplitType: jsii.String("splitType"), }, TransformOutput: &TransformOutputProperty{ S3OutputPath: jsii.String("s3OutputPath"), // the properties below are optional Accept: jsii.String("accept"), AssembleWith: jsii.String("assembleWith"), KmsKeyId: jsii.String("kmsKeyId"), }, TransformResources: &TransformResourcesProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, // the properties below are optional BatchStrategy: jsii.String("batchStrategy"), Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, MaxConcurrentTransforms: jsii.Number(123), MaxPayloadInMb: jsii.Number(123), }, }, }, ValidationRole: jsii.String("validationRole"), }
type CfnModelProps ¶
type CfnModelProps struct { // Specifies the containers in the inference pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-containers // Containers interface{} `field:"optional" json:"containers" yaml:"containers"` // Isolates the model container. // // No inbound or outbound network calls can be made to or from the model container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"enableNetworkIsolation"` // The Amazon Resource Name (ARN) of the IAM role that 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 [SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) . // // > To be able to pass this role to SageMaker, the caller of this API must have the `iam:PassRole` permission. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-executionrolearn // ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"` // Specifies details of how containers in a multi-container endpoint are called. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-inferenceexecutionconfig // InferenceExecutionConfig interface{} `field:"optional" json:"inferenceExecutionConfig" yaml:"inferenceExecutionConfig"` // The name of the new model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-modelname // ModelName *string `field:"optional" json:"modelName" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-primarycontainer // PrimaryContainer interface{} `field:"optional" json:"primaryContainer" yaml:"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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"` }
Properties for defining a `CfnModel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var environment interface{} cfnModelProps := &CfnModelProps{ Containers: []interface{}{ &ContainerDefinitionProperty{ ContainerHostname: jsii.String("containerHostname"), Environment: environment, Image: jsii.String("image"), ImageConfig: &ImageConfigProperty{ RepositoryAccessMode: jsii.String("repositoryAccessMode"), // the properties below are optional RepositoryAuthConfig: &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }, }, InferenceSpecificationName: jsii.String("inferenceSpecificationName"), Mode: jsii.String("mode"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelPackageName: jsii.String("modelPackageName"), MultiModelConfig: &MultiModelConfigProperty{ ModelCacheSetting: jsii.String("modelCacheSetting"), }, }, }, EnableNetworkIsolation: jsii.Boolean(false), ExecutionRoleArn: jsii.String("executionRoleArn"), InferenceExecutionConfig: &InferenceExecutionConfigProperty{ Mode: jsii.String("mode"), }, ModelName: jsii.String("modelName"), PrimaryContainer: &ContainerDefinitionProperty{ ContainerHostname: jsii.String("containerHostname"), Environment: environment, Image: jsii.String("image"), ImageConfig: &ImageConfigProperty{ RepositoryAccessMode: jsii.String("repositoryAccessMode"), // the properties below are optional RepositoryAuthConfig: &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }, }, InferenceSpecificationName: jsii.String("inferenceSpecificationName"), Mode: jsii.String("mode"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelPackageName: jsii.String("modelPackageName"), MultiModelConfig: &MultiModelConfigProperty{ ModelCacheSetting: jsii.String("modelCacheSetting"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html
type CfnModelQualityJobDefinition ¶
type CfnModelQualityJobDefinition interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time when the job definition was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the job definition. AttrJobDefinitionArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the endpoint used to run the monitoring job. EndpointName() *string SetEndpointName(val *string) // The name of the monitoring job definition. JobDefinitionName() *string SetJobDefinitionName(val *string) // Identifies the resources to deploy for a monitoring job. JobResources() interface{} SetJobResources(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Container image configuration object for the monitoring job. ModelQualityAppSpecification() interface{} SetModelQualityAppSpecification(val interface{}) // Specifies the constraints and baselines for the monitoring job. ModelQualityBaselineConfig() interface{} SetModelQualityBaselineConfig(val interface{}) // A list of the inputs that are monitored. ModelQualityJobInput() interface{} SetModelQualityJobInput(val interface{}) // The output configuration for monitoring jobs. ModelQualityJobOutputConfig() interface{} SetModelQualityJobOutputConfig(val interface{}) // Specifies the network configuration for the monitoring job. NetworkConfig() interface{} SetNetworkConfig(val interface{}) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A time limit for how long the monitoring job is allowed to run before stopping. StoppingCondition() interface{} SetStoppingCondition(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a definition for a job that monitors model quality and drift.
For information about model monitor, see [Amazon SageMaker Model Monitor](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnModelQualityJobDefinition := awscdk.Aws_sagemaker.NewCfnModelQualityJobDefinition(this, jsii.String("MyCfnModelQualityJobDefinition"), &CfnModelQualityJobDefinitionProps{ JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, ModelQualityAppSpecification: &ModelQualityAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), ProblemType: jsii.String("problemType"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, ModelQualityJobInput: &ModelQualityJobInputProperty{ GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }, // the properties below are optional BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, }, ModelQualityJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), ModelQualityBaselineConfig: &ModelQualityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnModelQualityJobDefinition ¶
func NewCfnModelQualityJobDefinition(scope constructs.Construct, id *string, props *CfnModelQualityJobDefinitionProps) CfnModelQualityJobDefinition
type CfnModelQualityJobDefinitionProps ¶
type CfnModelQualityJobDefinitionProps struct { // Identifies the resources to deploy for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-jobresources // JobResources interface{} `field:"required" json:"jobResources" yaml:"jobResources"` // Container image configuration object for the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification // ModelQualityAppSpecification interface{} `field:"required" json:"modelQualityAppSpecification" yaml:"modelQualityAppSpecification"` // A list of the inputs that are monitored. // // Currently endpoints are supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjobinput // ModelQualityJobInput interface{} `field:"required" json:"modelQualityJobInput" yaml:"modelQualityJobInput"` // The output configuration for monitoring jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjoboutputconfig // ModelQualityJobOutputConfig interface{} `field:"required" json:"modelQualityJobOutputConfig" yaml:"modelQualityJobOutputConfig"` // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the endpoint used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // The name of the monitoring job definition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-jobdefinitionname // JobDefinitionName *string `field:"optional" json:"jobDefinitionName" yaml:"jobDefinitionName"` // Specifies the constraints and baselines for the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualitybaselineconfig // ModelQualityBaselineConfig interface{} `field:"optional" json:"modelQualityBaselineConfig" yaml:"modelQualityBaselineConfig"` // Specifies the network configuration for the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-networkconfig // NetworkConfig interface{} `field:"optional" json:"networkConfig" yaml:"networkConfig"` // A time limit for how long the monitoring job is allowed to run before stopping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-stoppingcondition // StoppingCondition interface{} `field:"optional" json:"stoppingCondition" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnModelQualityJobDefinition`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnModelQualityJobDefinitionProps := &CfnModelQualityJobDefinitionProps{ JobResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, ModelQualityAppSpecification: &ModelQualityAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), ProblemType: jsii.String("problemType"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, ModelQualityJobInput: &ModelQualityJobInputProperty{ GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }, // the properties below are optional BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, }, ModelQualityJobOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, RoleArn: jsii.String("roleArn"), // the properties below are optional EndpointName: jsii.String("endpointName"), JobDefinitionName: jsii.String("jobDefinitionName"), ModelQualityBaselineConfig: &ModelQualityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnModelQualityJobDefinition_BatchTransformInputProperty ¶ added in v2.48.0
type CfnModelQualityJobDefinition_BatchTransformInputProperty struct { // The Amazon S3 location being used to capture the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-datacaptureddestinations3uri // DataCapturedDestinationS3Uri *string `field:"required" json:"dataCapturedDestinationS3Uri" yaml:"dataCapturedDestinationS3Uri"` // The dataset format for your batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-datasetformat // DatasetFormat interface{} `field:"required" json:"datasetFormat" yaml:"datasetFormat"` // Path to the filesystem where the batch transform data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // If specified, monitoring jobs subtract 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-endtimeoffset // EndTimeOffset *string `field:"optional" json:"endTimeOffset" yaml:"endTimeOffset"` // The attribute of the input data that represents the ground truth label. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-inferenceattribute // InferenceAttribute *string `field:"optional" json:"inferenceAttribute" yaml:"inferenceAttribute"` // In a classification problem, the attribute that represents the class probability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // The threshold for the class probability to be evaluated as a positive result. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-probabilitythresholdattribute // ProbabilityThresholdAttribute *float64 `field:"optional" json:"probabilityThresholdAttribute" yaml:"probabilityThresholdAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-starttimeoffset // StartTimeOffset *string `field:"optional" json:"startTimeOffset" yaml:"startTimeOffset"` }
Input object for the batch transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" batchTransformInputProperty := &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-clusterconfig.html#cfn-sagemaker-modelqualityjobdefinition-clusterconfig-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The ML compute instance type for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-clusterconfig.html#cfn-sagemaker-modelqualityjobdefinition-clusterconfig-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The size of the ML storage volume, in gigabytes, that you want to provision. // // You must specify sufficient ML storage for your scenario. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-clusterconfig.html#cfn-sagemaker-modelqualityjobdefinition-clusterconfig-volumesizeingb // VolumeSizeInGb *float64 `field:"required" json:"volumeSizeInGb" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-clusterconfig.html#cfn-sagemaker-modelqualityjobdefinition-clusterconfig-volumekmskeyid // VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"` }
The configuration for the cluster of resources used to run the processing job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterConfigProperty := &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }
type CfnModelQualityJobDefinition_ConstraintsResourceProperty ¶
type CfnModelQualityJobDefinition_ConstraintsResourceProperty struct { // The Amazon S3 URI for the constraints resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-constraintsresource.html#cfn-sagemaker-modelqualityjobdefinition-constraintsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
The constraints resource for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" constraintsResourceProperty := &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnModelQualityJobDefinition_CsvProperty ¶ added in v2.48.0
type CfnModelQualityJobDefinition_CsvProperty struct { // A boolean flag indicating if given CSV has header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-csv.html#cfn-sagemaker-modelqualityjobdefinition-csv-header // Header interface{} `field:"optional" json:"header" yaml:"header"` }
The CSV format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvProperty := &CsvProperty{ Header: jsii.Boolean(false), }
type CfnModelQualityJobDefinition_DatasetFormatProperty ¶ added in v2.48.0
type CfnModelQualityJobDefinition_DatasetFormatProperty struct { // The CSV format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-datasetformat.html#cfn-sagemaker-modelqualityjobdefinition-datasetformat-csv // Csv interface{} `field:"optional" json:"csv" yaml:"csv"` // The Json format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-datasetformat.html#cfn-sagemaker-modelqualityjobdefinition-datasetformat-json // Json interface{} `field:"optional" json:"json" yaml:"json"` // A flag indicating if the dataset format is Parquet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-datasetformat.html#cfn-sagemaker-modelqualityjobdefinition-datasetformat-parquet // Parquet interface{} `field:"optional" json:"parquet" yaml:"parquet"` }
The dataset format of the data to monitor.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetFormatProperty := &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }
type CfnModelQualityJobDefinition_EndpointInputProperty ¶
type CfnModelQualityJobDefinition_EndpointInputProperty struct { // An endpoint in customer's account which has enabled `DataCaptureConfig` enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // Path to the filesystem where the endpoint data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-endtimeoffset // EndTimeOffset *string `field:"optional" json:"endTimeOffset" yaml:"endTimeOffset"` // The attribute of the input data that represents the ground truth label. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-inferenceattribute // InferenceAttribute *string `field:"optional" json:"inferenceAttribute" yaml:"inferenceAttribute"` // In a classification problem, the attribute that represents the class probability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-probabilityattribute // ProbabilityAttribute *string `field:"optional" json:"probabilityAttribute" yaml:"probabilityAttribute"` // The threshold for the class probability to be evaluated as a positive result. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-probabilitythresholdattribute // ProbabilityThresholdAttribute *float64 `field:"optional" json:"probabilityThresholdAttribute" yaml:"probabilityThresholdAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-endpointinput.html#cfn-sagemaker-modelqualityjobdefinition-endpointinput-starttimeoffset // StartTimeOffset *string `field:"optional" json:"startTimeOffset" yaml:"startTimeOffset"` }
Input object for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointInputProperty := &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }
type CfnModelQualityJobDefinition_JsonProperty ¶ added in v2.48.0
type CfnModelQualityJobDefinition_JsonProperty struct { // A boolean flag indicating if it is JSON line format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-json.html#cfn-sagemaker-modelqualityjobdefinition-json-line // Line interface{} `field:"optional" json:"line" yaml:"line"` }
The Json format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jsonProperty := &JsonProperty{ Line: jsii.Boolean(false), }
type CfnModelQualityJobDefinition_ModelQualityAppSpecificationProperty ¶
type CfnModelQualityJobDefinition_ModelQualityAppSpecificationProperty struct { // The address of the container image that the monitoring job runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-imageuri // ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"` // The machine learning problem type of the model that the monitoring job monitors. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-problemtype // ProblemType *string `field:"required" json:"problemType" yaml:"problemType"` // An array of arguments for the container used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-containerarguments // ContainerArguments *[]*string `field:"optional" json:"containerArguments" yaml:"containerArguments"` // Specifies the entrypoint for a container that the monitoring job runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-containerentrypoint // ContainerEntrypoint *[]*string `field:"optional" json:"containerEntrypoint" yaml:"containerEntrypoint"` // Sets the environment variables in the container that the monitoring job runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-environment // Environment interface{} `field:"optional" json:"environment" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-postanalyticsprocessorsourceuri // PostAnalyticsProcessorSourceUri *string `field:"optional" json:"postAnalyticsProcessorSourceUri" yaml:"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 flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityappspecification.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification-recordpreprocessorsourceuri // RecordPreprocessorSourceUri *string `field:"optional" json:"recordPreprocessorSourceUri" yaml:"recordPreprocessorSourceUri"` }
Container image configuration object for the monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelQualityAppSpecificationProperty := &ModelQualityAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), ProblemType: jsii.String("problemType"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }
type CfnModelQualityJobDefinition_ModelQualityBaselineConfigProperty ¶
type CfnModelQualityJobDefinition_ModelQualityBaselineConfigProperty struct { // The name of the job that performs baselining for the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualitybaselineconfig.html#cfn-sagemaker-modelqualityjobdefinition-modelqualitybaselineconfig-baseliningjobname // BaseliningJobName *string `field:"optional" json:"baseliningJobName" yaml:"baseliningJobName"` // The constraints resource for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualitybaselineconfig.html#cfn-sagemaker-modelqualityjobdefinition-modelqualitybaselineconfig-constraintsresource // ConstraintsResource interface{} `field:"optional" json:"constraintsResource" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelQualityBaselineConfigProperty := &ModelQualityBaselineConfigProperty{ BaseliningJobName: jsii.String("baseliningJobName"), ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }
type CfnModelQualityJobDefinition_ModelQualityJobInputProperty ¶
type CfnModelQualityJobDefinition_ModelQualityJobInputProperty struct { // The ground truth label provided for the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityjobinput.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjobinput-groundtruths3input // GroundTruthS3Input interface{} `field:"required" json:"groundTruthS3Input" yaml:"groundTruthS3Input"` // Input object for the batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityjobinput.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjobinput-batchtransforminput // BatchTransformInput interface{} `field:"optional" json:"batchTransformInput" yaml:"batchTransformInput"` // Input object for the endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-modelqualityjobinput.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjobinput-endpointinput // EndpointInput interface{} `field:"optional" json:"endpointInput" yaml:"endpointInput"` }
The input for the model quality monitoring job.
Currently endpoints are supported for input for model quality monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelQualityJobInputProperty := &ModelQualityJobInputProperty{ GroundTruthS3Input: &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }, // the properties below are optional BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional EndTimeOffset: jsii.String("endTimeOffset"), InferenceAttribute: jsii.String("inferenceAttribute"), ProbabilityAttribute: jsii.String("probabilityAttribute"), ProbabilityThresholdAttribute: jsii.Number(123), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), StartTimeOffset: jsii.String("startTimeOffset"), }, }
type CfnModelQualityJobDefinition_MonitoringGroundTruthS3InputProperty ¶
type CfnModelQualityJobDefinition_MonitoringGroundTruthS3InputProperty struct { // The address of the Amazon S3 location of the ground truth labels. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-monitoringgroundtruths3input.html#cfn-sagemaker-modelqualityjobdefinition-monitoringgroundtruths3input-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` }
The ground truth labels for the dataset used for the monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringGroundTruthS3InputProperty := &MonitoringGroundTruthS3InputProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnModelQualityJobDefinition_MonitoringOutputConfigProperty ¶
type CfnModelQualityJobDefinition_MonitoringOutputConfigProperty struct { // Monitoring outputs for monitoring jobs. // // This is where the output of the periodic monitoring jobs is uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-modelqualityjobdefinition-monitoringoutputconfig-monitoringoutputs // MonitoringOutputs interface{} `field:"required" json:"monitoringOutputs" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-monitoringoutputconfig.html#cfn-sagemaker-modelqualityjobdefinition-monitoringoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The output configuration for monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputConfigProperty := &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnModelQualityJobDefinition_MonitoringOutputProperty ¶
type CfnModelQualityJobDefinition_MonitoringOutputProperty struct { // The Amazon S3 storage location where the results of a monitoring job are saved. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-monitoringoutput.html#cfn-sagemaker-modelqualityjobdefinition-monitoringoutput-s3output // S3Output interface{} `field:"required" json:"s3Output" yaml:"s3Output"` }
The output object for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputProperty := &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }
type CfnModelQualityJobDefinition_MonitoringResourcesProperty ¶
type CfnModelQualityJobDefinition_MonitoringResourcesProperty struct { // The configuration for the cluster resources used to run the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-monitoringresources.html#cfn-sagemaker-modelqualityjobdefinition-monitoringresources-clusterconfig // ClusterConfig interface{} `field:"required" json:"clusterConfig" yaml:"clusterConfig"` }
Identifies the resources to deploy for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringResourcesProperty := &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-networkconfig.html#cfn-sagemaker-modelqualityjobdefinition-networkconfig-enableintercontainertrafficencryption // EnableInterContainerTrafficEncryption interface{} `field:"optional" json:"enableInterContainerTrafficEncryption" yaml:"enableInterContainerTrafficEncryption"` // Whether to allow inbound and outbound network calls to and from the containers used for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-networkconfig.html#cfn-sagemaker-modelqualityjobdefinition-networkconfig-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-networkconfig.html#cfn-sagemaker-modelqualityjobdefinition-networkconfig-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" networkConfigProperty := &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-s3output.html#cfn-sagemaker-modelqualityjobdefinition-s3output-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-s3output.html#cfn-sagemaker-modelqualityjobdefinition-s3output-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // Whether to upload the results of the monitoring job continuously or after the job completes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-s3output.html#cfn-sagemaker-modelqualityjobdefinition-s3output-s3uploadmode // S3UploadMode *string `field:"optional" json:"s3UploadMode" yaml:"s3UploadMode"` }
The Amazon S3 storage location where the results of a monitoring job are saved.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3OutputProperty := &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }
type CfnModelQualityJobDefinition_StoppingConditionProperty ¶
type CfnModelQualityJobDefinition_StoppingConditionProperty struct { // The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. // // For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model. // // For all other jobs, if the job does not complete during this time, 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. // // The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-stoppingcondition.html#cfn-sagemaker-modelqualityjobdefinition-stoppingcondition-maxruntimeinseconds // MaxRuntimeInSeconds *float64 `field:"required" json:"maxRuntimeInSeconds" yaml:"maxRuntimeInSeconds"` }
Specifies a limit to how long a job can run.
When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, 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 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stoppingConditionProperty := &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-vpcconfig.html#cfn-sagemaker-modelqualityjobdefinition-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-vpcconfig.html#cfn-sagemaker-modelqualityjobdefinition-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-containerhostname // ContainerHostname *string `field:"optional" json:"containerHostname" yaml:"containerHostname"` // The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. // // The maximum length of each key and value in the `Environment` map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a `CreateModel` request, then the maximum length of all of their maps, combined, is also 32 KB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-environment // Environment interface{} `field:"optional" json:"environment" yaml:"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 SageMaker, the inference code must meet SageMaker requirements. 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) . // // > The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-image // Image *string `field:"optional" json:"image" yaml:"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) . // // > The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-imageconfig // ImageConfig interface{} `field:"optional" json:"imageConfig" yaml:"imageConfig"` // The inference specification name in the model package version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-inferencespecificationname // InferenceSpecificationName *string `field:"optional" json:"inferenceSpecificationName" yaml:"inferenceSpecificationName"` // Whether the container hosts a single model or multiple models. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-mode // Mode *string `field:"optional" json:"mode" yaml:"mode"` // Specifies the location of ML model data to deploy. // // > Currently you cannot use `ModelDataSource` in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modeldatasource // ModelDataSource interface{} `field:"optional" json:"modelDataSource" yaml:"modelDataSource"` // 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 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, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your AWS 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, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modeldataurl // ModelDataUrl *string `field:"optional" json:"modelDataUrl" yaml:"modelDataUrl"` // The name or Amazon Resource Name (ARN) of the model package to use to create the model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modelpackagename // ModelPackageName *string `field:"optional" json:"modelPackageName" yaml:"modelPackageName"` // Specifies additional configuration for multi-model endpoints. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-multimodelconfig // MultiModelConfig interface{} `field:"optional" json:"multiModelConfig" yaml:"multiModelConfig"` }
Describes the container, as part of model definition.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var environment interface{} containerDefinitionProperty := &ContainerDefinitionProperty{ ContainerHostname: jsii.String("containerHostname"), Environment: environment, Image: jsii.String("image"), ImageConfig: &ImageConfigProperty{ RepositoryAccessMode: jsii.String("repositoryAccessMode"), // the properties below are optional RepositoryAuthConfig: &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }, }, InferenceSpecificationName: jsii.String("inferenceSpecificationName"), Mode: jsii.String("mode"), ModelDataSource: &ModelDataSourceProperty{ S3DataSource: &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }, ModelDataUrl: jsii.String("modelDataUrl"), ModelPackageName: jsii.String("modelPackageName"), MultiModelConfig: &MultiModelConfigProperty{ ModelCacheSetting: jsii.String("modelCacheSetting"), }, }
type CfnModel_HubAccessConfigProperty ¶ added in v2.154.0
type CfnModel_HubAccessConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-hubaccessconfig.html#cfn-sagemaker-model-hubaccessconfig-hubcontentarn // HubContentArn *string `field:"required" json:"hubContentArn" yaml:"hubContentArn"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" hubAccessConfigProperty := &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-imageconfig.html#cfn-sagemaker-model-imageconfig-repositoryaccessmode // RepositoryAccessMode *string `field:"required" json:"repositoryAccessMode" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-imageconfig.html#cfn-sagemaker-model-imageconfig-repositoryauthconfig // RepositoryAuthConfig interface{} `field:"optional" json:"repositoryAuthConfig" yaml:"repositoryAuthConfig"` }
Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" imageConfigProperty := &ImageConfigProperty{ RepositoryAccessMode: jsii.String("repositoryAccessMode"), // the properties below are optional RepositoryAuthConfig: &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-inferenceexecutionconfig.html#cfn-sagemaker-model-inferenceexecutionconfig-mode // Mode *string `field:"required" json:"mode" yaml:"mode"` }
Specifies details about how containers in a multi-container endpoint are run.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inferenceExecutionConfigProperty := &InferenceExecutionConfigProperty{ Mode: jsii.String("mode"), }
type CfnModel_ModelAccessConfigProperty ¶ added in v2.122.0
type CfnModel_ModelAccessConfigProperty struct { // Specifies agreement to the model end-user license agreement (EULA). // // The `AcceptEula` value must be explicitly defined as `True` in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-modelaccessconfig.html#cfn-sagemaker-model-modelaccessconfig-accepteula // AcceptEula interface{} `field:"required" json:"acceptEula" yaml:"acceptEula"` }
The access configuration file to control access to the ML model.
You can explicitly accept the model end-user license agreement (EULA) within the `ModelAccessConfig` .
- If you are a Jumpstart user, see the [End-user license agreements](https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula) section for more details on accepting the EULA. - If you are an AutoML user, see the *Optional Parameters* section of *Create an AutoML job to fine-tune text generation models using the API* for details on [How to set the EULA acceptance when fine-tuning a model using the AutoML API](https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelAccessConfigProperty := &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }
type CfnModel_ModelDataSourceProperty ¶ added in v2.114.0
type CfnModel_ModelDataSourceProperty struct { // Specifies the S3 location of ML model data to deploy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-modeldatasource.html#cfn-sagemaker-model-modeldatasource-s3datasource // S3DataSource interface{} `field:"required" json:"s3DataSource" yaml:"s3DataSource"` }
Specifies the location of ML model data to deploy.
If specified, you must specify one and only one of the available data sources.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" modelDataSourceProperty := &ModelDataSourceProperty{ S3DataSource: &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-multimodelconfig.html#cfn-sagemaker-model-multimodelconfig-modelcachesetting // ModelCacheSetting *string `field:"optional" json:"modelCacheSetting" yaml:"modelCacheSetting"` }
Specifies additional configuration for hosting multi-model endpoints.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" multiModelConfigProperty := &MultiModelConfigProperty{ ModelCacheSetting: jsii.String("modelCacheSetting"), }
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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-repositoryauthconfig.html#cfn-sagemaker-model-repositoryauthconfig-repositorycredentialsproviderarn // RepositoryCredentialsProviderArn *string `field:"required" json:"repositoryCredentialsProviderArn" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" repositoryAuthConfigProperty := &RepositoryAuthConfigProperty{ RepositoryCredentialsProviderArn: jsii.String("repositoryCredentialsProviderArn"), }
type CfnModel_S3DataSourceProperty ¶ added in v2.114.0
type CfnModel_S3DataSourceProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-compressiontype // CompressionType *string `field:"required" json:"compressionType" yaml:"compressionType"` // If you choose `S3Prefix` , `S3Uri` identifies a key name prefix. // // SageMaker uses all objects that match the specified key name prefix for model training. // // If you choose `ManifestFile` , `S3Uri` identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training. // // If you choose `AugmentedManifestFile` , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. `AugmentedManifestFile` can only be used if the Channel's input mode is `Pipe` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-s3datatype // S3DataType *string `field:"required" json:"s3DataType" yaml:"s3DataType"` // Depending on the value specified for the `S3DataType` , identifies either a key name prefix or a manifest. // // For example: // // - A key name prefix might look like this: `s3://bucketname/exampleprefix/` // - A manifest might look like this: `s3://bucketname/example.manifest` // // A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of `S3Uri` . Note that the prefix must be a valid non-empty `S3Uri` that precludes users from specifying a manifest whose individual `S3Uri` is sourced from different S3 buckets. // // The following code example shows a valid manifest format: // // `[ {"prefix": "s3://customer_bucket/some/prefix/"},` // // `"relative/path/to/custdata-1",` // // `"relative/path/custdata-2",` // // `...` // // `"relative/path/custdata-N"` // // `]` // // This JSON is equivalent to the following `S3Uri` list: // // `s3://customer_bucket/some/prefix/relative/path/to/custdata-1` // // `s3://customer_bucket/some/prefix/relative/path/custdata-2` // // `...` // // `s3://customer_bucket/some/prefix/relative/path/custdata-N` // // The complete set of `S3Uri` in this manifest is the input data for the channel for this data source. The object that each `S3Uri` points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf. // // Your input bucket must be located in same AWS region as your training job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-hubaccessconfig // HubAccessConfig interface{} `field:"optional" json:"hubAccessConfig" yaml:"hubAccessConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-modelaccessconfig // ModelAccessConfig interface{} `field:"optional" json:"modelAccessConfig" yaml:"modelAccessConfig"` }
Describes the S3 data source.
Your input bucket must be in the same AWS region as your training job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3DataSourceProperty := &S3DataSourceProperty{ CompressionType: jsii.String("compressionType"), S3DataType: jsii.String("s3DataType"), S3Uri: jsii.String("s3Uri"), // the properties below are optional HubAccessConfig: &HubAccessConfigProperty{ HubContentArn: jsii.String("hubContentArn"), }, ModelAccessConfig: &ModelAccessConfigProperty{ AcceptEula: jsii.Boolean(false), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-vpcconfig.html#cfn-sagemaker-model-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-vpcconfig.html#cfn-sagemaker-model-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
type CfnMonitoringSchedule ¶
type CfnMonitoringSchedule interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time when the monitoring schedule was created. AttrCreationTime() *string // The last time that the monitoring schedule was modified. AttrLastModifiedTime() *string // The Amazon Resource Name (ARN) of the monitoring schedule. AttrMonitoringScheduleArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the endpoint using the monitoring schedule. EndpointName() *string SetEndpointName(val *string) // Contains the reason a monitoring job failed, if it failed. FailureReason() *string SetFailureReason(val *string) // Describes metadata on the last execution to run, if there was one. LastMonitoringExecutionSummary() interface{} SetLastMonitoringExecutionSummary(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The configuration object that specifies the monitoring schedule and defines the monitoring job. MonitoringScheduleConfig() interface{} SetMonitoringScheduleConfig(val interface{}) // The name of the monitoring schedule. MonitoringScheduleName() *string SetMonitoringScheduleName(val *string) // The status of the monitoring schedule. MonitoringScheduleStatus() *string SetMonitoringScheduleStatus(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMonitoringSchedule := awscdk.Aws_sagemaker.NewCfnMonitoringSchedule(this, jsii.String("MyCfnMonitoringSchedule"), &CfnMonitoringScheduleProps{ MonitoringScheduleConfig: &MonitoringScheduleConfigProperty{ MonitoringJobDefinition: &MonitoringJobDefinitionProperty{ MonitoringAppSpecification: &MonitoringAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, MonitoringInputs: []interface{}{ &MonitoringInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, }, MonitoringOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, MonitoringResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional BaselineConfig: &BaselineConfigProperty{ ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, }, MonitoringJobDefinitionName: jsii.String("monitoringJobDefinitionName"), MonitoringType: jsii.String("monitoringType"), ScheduleConfig: &ScheduleConfigProperty{ ScheduleExpression: jsii.String("scheduleExpression"), // the properties below are optional DataAnalysisEndTime: jsii.String("dataAnalysisEndTime"), DataAnalysisStartTime: jsii.String("dataAnalysisStartTime"), }, }, MonitoringScheduleName: jsii.String("monitoringScheduleName"), // the properties below are optional EndpointName: jsii.String("endpointName"), FailureReason: jsii.String("failureReason"), LastMonitoringExecutionSummary: &MonitoringExecutionSummaryProperty{ CreationTime: jsii.String("creationTime"), LastModifiedTime: jsii.String("lastModifiedTime"), MonitoringExecutionStatus: jsii.String("monitoringExecutionStatus"), MonitoringScheduleName: jsii.String("monitoringScheduleName"), ScheduledTime: jsii.String("scheduledTime"), // the properties below are optional EndpointName: jsii.String("endpointName"), FailureReason: jsii.String("failureReason"), ProcessingJobArn: jsii.String("processingJobArn"), }, MonitoringScheduleStatus: jsii.String("monitoringScheduleStatus"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMonitoringSchedule ¶
func NewCfnMonitoringSchedule(scope constructs.Construct, id *string, props *CfnMonitoringScheduleProps) CfnMonitoringSchedule
type CfnMonitoringScheduleProps ¶
type CfnMonitoringScheduleProps struct { // The configuration object that specifies the monitoring schedule and defines the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig // MonitoringScheduleConfig interface{} `field:"required" json:"monitoringScheduleConfig" yaml:"monitoringScheduleConfig"` // The name of the monitoring schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulename // MonitoringScheduleName *string `field:"required" json:"monitoringScheduleName" yaml:"monitoringScheduleName"` // The name of the endpoint using the monitoring schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // Contains the reason a monitoring job failed, if it failed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-failurereason // FailureReason *string `field:"optional" json:"failureReason" yaml:"failureReason"` // Describes metadata on the last execution to run, if there was one. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-lastmonitoringexecutionsummary // LastMonitoringExecutionSummary interface{} `field:"optional" json:"lastMonitoringExecutionSummary" yaml:"lastMonitoringExecutionSummary"` // The status of the monitoring schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulestatus // MonitoringScheduleStatus *string `field:"optional" json:"monitoringScheduleStatus" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMonitoringSchedule`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMonitoringScheduleProps := &CfnMonitoringScheduleProps{ MonitoringScheduleConfig: &MonitoringScheduleConfigProperty{ MonitoringJobDefinition: &MonitoringJobDefinitionProperty{ MonitoringAppSpecification: &MonitoringAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, MonitoringInputs: []interface{}{ &MonitoringInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, }, MonitoringOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, MonitoringResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional BaselineConfig: &BaselineConfigProperty{ ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, }, MonitoringJobDefinitionName: jsii.String("monitoringJobDefinitionName"), MonitoringType: jsii.String("monitoringType"), ScheduleConfig: &ScheduleConfigProperty{ ScheduleExpression: jsii.String("scheduleExpression"), // the properties below are optional DataAnalysisEndTime: jsii.String("dataAnalysisEndTime"), DataAnalysisStartTime: jsii.String("dataAnalysisStartTime"), }, }, MonitoringScheduleName: jsii.String("monitoringScheduleName"), // the properties below are optional EndpointName: jsii.String("endpointName"), FailureReason: jsii.String("failureReason"), LastMonitoringExecutionSummary: &MonitoringExecutionSummaryProperty{ CreationTime: jsii.String("creationTime"), LastModifiedTime: jsii.String("lastModifiedTime"), MonitoringExecutionStatus: jsii.String("monitoringExecutionStatus"), MonitoringScheduleName: jsii.String("monitoringScheduleName"), ScheduledTime: jsii.String("scheduledTime"), // the properties below are optional EndpointName: jsii.String("endpointName"), FailureReason: jsii.String("failureReason"), ProcessingJobArn: jsii.String("processingJobArn"), }, MonitoringScheduleStatus: jsii.String("monitoringScheduleStatus"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnMonitoringSchedule_BaselineConfigProperty ¶
type CfnMonitoringSchedule_BaselineConfigProperty struct { // The Amazon S3 URI for the constraints resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-baselineconfig.html#cfn-sagemaker-monitoringschedule-baselineconfig-constraintsresource // ConstraintsResource interface{} `field:"optional" json:"constraintsResource" yaml:"constraintsResource"` // The baseline statistics file in Amazon S3 that the current monitoring job should be validated against. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-baselineconfig.html#cfn-sagemaker-monitoringschedule-baselineconfig-statisticsresource // StatisticsResource interface{} `field:"optional" json:"statisticsResource" yaml:"statisticsResource"` }
Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" baselineConfigProperty := &BaselineConfigProperty{ ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }
type CfnMonitoringSchedule_BatchTransformInputProperty ¶ added in v2.48.0
type CfnMonitoringSchedule_BatchTransformInputProperty struct { // The Amazon S3 location being used to capture the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-datacaptureddestinations3uri // DataCapturedDestinationS3Uri *string `field:"required" json:"dataCapturedDestinationS3Uri" yaml:"dataCapturedDestinationS3Uri"` // The dataset format for your batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-datasetformat // DatasetFormat interface{} `field:"required" json:"datasetFormat" yaml:"datasetFormat"` // Path to the filesystem where the batch transform data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // The attributes of the input data to exclude from the analysis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-excludefeaturesattribute // ExcludeFeaturesAttribute *string `field:"optional" json:"excludeFeaturesAttribute" yaml:"excludeFeaturesAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-batchtransforminput.html#cfn-sagemaker-monitoringschedule-batchtransforminput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"s3InputMode"` }
Input object for the batch transform job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" batchTransformInputProperty := &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-instancecount // InstanceCount *float64 `field:"required" json:"instanceCount" yaml:"instanceCount"` // The ML compute instance type for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // The size of the ML storage volume, in gigabytes, that you want to provision. // // You must specify sufficient ML storage for your scenario. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-volumesizeingb // VolumeSizeInGb *float64 `field:"required" json:"volumeSizeInGb" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-clusterconfig.html#cfn-sagemaker-monitoringschedule-clusterconfig-volumekmskeyid // VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"` }
Configuration for the cluster used to run model monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clusterConfigProperty := &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }
type CfnMonitoringSchedule_ConstraintsResourceProperty ¶
type CfnMonitoringSchedule_ConstraintsResourceProperty struct { // The Amazon S3 URI for the constraints resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-constraintsresource.html#cfn-sagemaker-monitoringschedule-constraintsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
The Amazon S3 URI for the constraints resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" constraintsResourceProperty := &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnMonitoringSchedule_CsvProperty ¶ added in v2.48.0
type CfnMonitoringSchedule_CsvProperty struct { // A boolean flag indicating if given CSV has header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-csv.html#cfn-sagemaker-monitoringschedule-csv-header // Header interface{} `field:"optional" json:"header" yaml:"header"` }
The CSV format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" csvProperty := &CsvProperty{ Header: jsii.Boolean(false), }
type CfnMonitoringSchedule_DatasetFormatProperty ¶ added in v2.48.0
type CfnMonitoringSchedule_DatasetFormatProperty struct { // The CSV format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html#cfn-sagemaker-monitoringschedule-datasetformat-csv // Csv interface{} `field:"optional" json:"csv" yaml:"csv"` // The Json format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html#cfn-sagemaker-monitoringschedule-datasetformat-json // Json interface{} `field:"optional" json:"json" yaml:"json"` // A flag indicating if the dataset format is Parquet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-datasetformat.html#cfn-sagemaker-monitoringschedule-datasetformat-parquet // Parquet interface{} `field:"optional" json:"parquet" yaml:"parquet"` }
The dataset format of the data to monitor.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetFormatProperty := &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }
type CfnMonitoringSchedule_EndpointInputProperty ¶
type CfnMonitoringSchedule_EndpointInputProperty struct { // An endpoint in customer's account which has enabled `DataCaptureConfig` enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-endpointname // EndpointName *string `field:"required" json:"endpointName" yaml:"endpointName"` // Path to the filesystem where the endpoint data is available to the container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // The attributes of the input data to exclude from the analysis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-excludefeaturesattribute // ExcludeFeaturesAttribute *string `field:"optional" json:"excludeFeaturesAttribute" yaml:"excludeFeaturesAttribute"` // Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. // // Defaults to `FullyReplicated`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-s3datadistributiontype // S3DataDistributionType *string `field:"optional" json:"s3DataDistributionType" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-endpointinput.html#cfn-sagemaker-monitoringschedule-endpointinput-s3inputmode // S3InputMode *string `field:"optional" json:"s3InputMode" yaml:"s3InputMode"` }
Input object for the endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointInputProperty := &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }
type CfnMonitoringSchedule_JsonProperty ¶ added in v2.48.0
type CfnMonitoringSchedule_JsonProperty struct { // A boolean flag indicating if it is JSON line format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-json.html#cfn-sagemaker-monitoringschedule-json-line // Line interface{} `field:"optional" json:"line" yaml:"line"` }
The Json format.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jsonProperty := &JsonProperty{ Line: jsii.Boolean(false), }
type CfnMonitoringSchedule_MonitoringAppSpecificationProperty ¶
type CfnMonitoringSchedule_MonitoringAppSpecificationProperty struct { // The container image to be run by the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-imageuri // ImageUri *string `field:"required" json:"imageUri" yaml:"imageUri"` // An array of arguments for the container used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-containerarguments // ContainerArguments *[]*string `field:"optional" json:"containerArguments" yaml:"containerArguments"` // Specifies the entrypoint for a container used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-containerentrypoint // ContainerEntrypoint *[]*string `field:"optional" json:"containerEntrypoint" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-postanalyticsprocessorsourceuri // PostAnalyticsProcessorSourceUri *string `field:"optional" json:"postAnalyticsProcessorSourceUri" yaml:"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 flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringappspecification.html#cfn-sagemaker-monitoringschedule-monitoringappspecification-recordpreprocessorsourceuri // RecordPreprocessorSourceUri *string `field:"optional" json:"recordPreprocessorSourceUri" yaml:"recordPreprocessorSourceUri"` }
Container image configuration object for the monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringAppSpecificationProperty := &MonitoringAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }
type CfnMonitoringSchedule_MonitoringExecutionSummaryProperty ¶
type CfnMonitoringSchedule_MonitoringExecutionSummaryProperty struct { // The time at which the monitoring job was created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-creationtime // CreationTime *string `field:"required" json:"creationTime" yaml:"creationTime"` // A timestamp that indicates the last time the monitoring job was modified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-lastmodifiedtime // LastModifiedTime *string `field:"required" json:"lastModifiedTime" yaml:"lastModifiedTime"` // The status of the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-monitoringexecutionstatus // MonitoringExecutionStatus *string `field:"required" json:"monitoringExecutionStatus" yaml:"monitoringExecutionStatus"` // The name of the monitoring schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-monitoringschedulename // MonitoringScheduleName *string `field:"required" json:"monitoringScheduleName" yaml:"monitoringScheduleName"` // The time the monitoring job was scheduled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-scheduledtime // ScheduledTime *string `field:"required" json:"scheduledTime" yaml:"scheduledTime"` // The name of the endpoint used to run the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // Contains the reason a monitoring job failed, if it failed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-failurereason // FailureReason *string `field:"optional" json:"failureReason" yaml:"failureReason"` // The Amazon Resource Name (ARN) of the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringexecutionsummary.html#cfn-sagemaker-monitoringschedule-monitoringexecutionsummary-processingjobarn // ProcessingJobArn *string `field:"optional" json:"processingJobArn" yaml:"processingJobArn"` }
Summary of information about the last monitoring job to run.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringExecutionSummaryProperty := &MonitoringExecutionSummaryProperty{ CreationTime: jsii.String("creationTime"), LastModifiedTime: jsii.String("lastModifiedTime"), MonitoringExecutionStatus: jsii.String("monitoringExecutionStatus"), MonitoringScheduleName: jsii.String("monitoringScheduleName"), ScheduledTime: jsii.String("scheduledTime"), // the properties below are optional EndpointName: jsii.String("endpointName"), FailureReason: jsii.String("failureReason"), ProcessingJobArn: jsii.String("processingJobArn"), }
type CfnMonitoringSchedule_MonitoringInputProperty ¶
type CfnMonitoringSchedule_MonitoringInputProperty struct { // Input object for the batch transform job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringinput.html#cfn-sagemaker-monitoringschedule-monitoringinput-batchtransforminput // BatchTransformInput interface{} `field:"optional" json:"batchTransformInput" yaml:"batchTransformInput"` // The endpoint for a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringinput.html#cfn-sagemaker-monitoringschedule-monitoringinput-endpointinput // EndpointInput interface{} `field:"optional" json:"endpointInput" yaml:"endpointInput"` }
The inputs for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringInputProperty := &MonitoringInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }
type CfnMonitoringSchedule_MonitoringJobDefinitionProperty ¶
type CfnMonitoringSchedule_MonitoringJobDefinitionProperty struct { // Configures the monitoring job to run a specified Docker container image. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringappspecification // MonitoringAppSpecification interface{} `field:"required" json:"monitoringAppSpecification" yaml:"monitoringAppSpecification"` // The array of inputs for the monitoring job. // // Currently we support monitoring an Amazon SageMaker Endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringinputs // MonitoringInputs interface{} `field:"required" json:"monitoringInputs" yaml:"monitoringInputs"` // The array of outputs from the monitoring job to be uploaded to Amazon S3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringoutputconfig // MonitoringOutputConfig interface{} `field:"required" json:"monitoringOutputConfig" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-monitoringresources // MonitoringResources interface{} `field:"required" json:"monitoringResources" yaml:"monitoringResources"` // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // Baseline configuration used to validate that the data conforms to the specified constraints and statistics. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-baselineconfig // BaselineConfig interface{} `field:"optional" json:"baselineConfig" yaml:"baselineConfig"` // Sets the environment variables in the Docker container. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // Specifies networking options for an monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-networkconfig // NetworkConfig interface{} `field:"optional" json:"networkConfig" yaml:"networkConfig"` // Specifies a time limit for how long the monitoring job is allowed to run. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringjobdefinition.html#cfn-sagemaker-monitoringschedule-monitoringjobdefinition-stoppingcondition // StoppingCondition interface{} `field:"optional" json:"stoppingCondition" yaml:"stoppingCondition"` }
Defines the monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringJobDefinitionProperty := &MonitoringJobDefinitionProperty{ MonitoringAppSpecification: &MonitoringAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, MonitoringInputs: []interface{}{ &MonitoringInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, }, MonitoringOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, MonitoringResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional BaselineConfig: &BaselineConfigProperty{ ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, }
type CfnMonitoringSchedule_MonitoringOutputConfigProperty ¶
type CfnMonitoringSchedule_MonitoringOutputConfigProperty struct { // Monitoring outputs for monitoring jobs. // // This is where the output of the periodic monitoring jobs is uploaded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutputconfig.html#cfn-sagemaker-monitoringschedule-monitoringoutputconfig-monitoringoutputs // MonitoringOutputs interface{} `field:"required" json:"monitoringOutputs" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutputconfig.html#cfn-sagemaker-monitoringschedule-monitoringoutputconfig-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The output configuration for monitoring jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputConfigProperty := &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnMonitoringSchedule_MonitoringOutputProperty ¶
type CfnMonitoringSchedule_MonitoringOutputProperty struct { // The Amazon S3 storage location where the results of a monitoring job are saved. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringoutput.html#cfn-sagemaker-monitoringschedule-monitoringoutput-s3output // S3Output interface{} `field:"required" json:"s3Output" yaml:"s3Output"` }
The output object for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringOutputProperty := &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }
type CfnMonitoringSchedule_MonitoringResourcesProperty ¶
type CfnMonitoringSchedule_MonitoringResourcesProperty struct { // The configuration for the cluster resources used to run the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringresources.html#cfn-sagemaker-monitoringschedule-monitoringresources-clusterconfig // ClusterConfig interface{} `field:"required" json:"clusterConfig" yaml:"clusterConfig"` }
Identifies the resources to deploy for a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringResourcesProperty := &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }
type CfnMonitoringSchedule_MonitoringScheduleConfigProperty ¶
type CfnMonitoringSchedule_MonitoringScheduleConfigProperty struct { // Defines the monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-monitoringjobdefinition // MonitoringJobDefinition interface{} `field:"optional" json:"monitoringJobDefinition" yaml:"monitoringJobDefinition"` // The name of the monitoring job definition to schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-monitoringjobdefinitionname // MonitoringJobDefinitionName *string `field:"optional" json:"monitoringJobDefinitionName" yaml:"monitoringJobDefinitionName"` // The type of the monitoring job definition to schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-monitoringtype // MonitoringType *string `field:"optional" json:"monitoringType" yaml:"monitoringType"` // Configures the monitoring schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-monitoringscheduleconfig.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig-scheduleconfig // ScheduleConfig interface{} `field:"optional" json:"scheduleConfig" yaml:"scheduleConfig"` }
Configures the monitoring schedule and defines the monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" monitoringScheduleConfigProperty := &MonitoringScheduleConfigProperty{ MonitoringJobDefinition: &MonitoringJobDefinitionProperty{ MonitoringAppSpecification: &MonitoringAppSpecificationProperty{ ImageUri: jsii.String("imageUri"), // the properties below are optional ContainerArguments: []*string{ jsii.String("containerArguments"), }, ContainerEntrypoint: []*string{ jsii.String("containerEntrypoint"), }, PostAnalyticsProcessorSourceUri: jsii.String("postAnalyticsProcessorSourceUri"), RecordPreprocessorSourceUri: jsii.String("recordPreprocessorSourceUri"), }, MonitoringInputs: []interface{}{ &MonitoringInputProperty{ BatchTransformInput: &BatchTransformInputProperty{ DataCapturedDestinationS3Uri: jsii.String("dataCapturedDestinationS3Uri"), DatasetFormat: &DatasetFormatProperty{ Csv: &CsvProperty{ Header: jsii.Boolean(false), }, Json: &JsonProperty{ Line: jsii.Boolean(false), }, Parquet: jsii.Boolean(false), }, LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, EndpointInput: &EndpointInputProperty{ EndpointName: jsii.String("endpointName"), LocalPath: jsii.String("localPath"), // the properties below are optional ExcludeFeaturesAttribute: jsii.String("excludeFeaturesAttribute"), S3DataDistributionType: jsii.String("s3DataDistributionType"), S3InputMode: jsii.String("s3InputMode"), }, }, }, MonitoringOutputConfig: &MonitoringOutputConfigProperty{ MonitoringOutputs: []interface{}{ &MonitoringOutputProperty{ S3Output: &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }, }, }, // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, MonitoringResources: &MonitoringResourcesProperty{ ClusterConfig: &ClusterConfigProperty{ InstanceCount: jsii.Number(123), InstanceType: jsii.String("instanceType"), VolumeSizeInGb: jsii.Number(123), // the properties below are optional VolumeKmsKeyId: jsii.String("volumeKmsKeyId"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional BaselineConfig: &BaselineConfigProperty{ ConstraintsResource: &ConstraintsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, StatisticsResource: &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }, }, Environment: map[string]*string{ "environmentKey": jsii.String("environment"), }, NetworkConfig: &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }, StoppingCondition: &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }, }, MonitoringJobDefinitionName: jsii.String("monitoringJobDefinitionName"), MonitoringType: jsii.String("monitoringType"), ScheduleConfig: &ScheduleConfigProperty{ ScheduleExpression: jsii.String("scheduleExpression"), // the properties below are optional DataAnalysisEndTime: jsii.String("dataAnalysisEndTime"), DataAnalysisStartTime: jsii.String("dataAnalysisStartTime"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html#cfn-sagemaker-monitoringschedule-networkconfig-enableintercontainertrafficencryption // EnableInterContainerTrafficEncryption interface{} `field:"optional" json:"enableInterContainerTrafficEncryption" yaml:"enableInterContainerTrafficEncryption"` // Whether to allow inbound and outbound network calls to and from the containers used for the processing job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html#cfn-sagemaker-monitoringschedule-networkconfig-enablenetworkisolation // EnableNetworkIsolation interface{} `field:"optional" json:"enableNetworkIsolation" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-networkconfig.html#cfn-sagemaker-monitoringschedule-networkconfig-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" networkConfigProperty := &NetworkConfigProperty{ EnableInterContainerTrafficEncryption: jsii.Boolean(false), EnableNetworkIsolation: jsii.Boolean(false), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html#cfn-sagemaker-monitoringschedule-s3output-localpath // LocalPath *string `field:"required" json:"localPath" yaml:"localPath"` // A URI that identifies the S3 storage location where SageMaker saves the results of a monitoring job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html#cfn-sagemaker-monitoringschedule-s3output-s3uri // S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"` // Whether to upload the results of the monitoring job continuously or after the job completes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-s3output.html#cfn-sagemaker-monitoringschedule-s3output-s3uploadmode // S3UploadMode *string `field:"optional" json:"s3UploadMode" yaml:"s3UploadMode"` }
Information about where and how you want to store the results of a monitoring job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3OutputProperty := &S3OutputProperty{ LocalPath: jsii.String("localPath"), S3Uri: jsii.String("s3Uri"), // the properties below are optional S3UploadMode: jsii.String("s3UploadMode"), }
type CfnMonitoringSchedule_ScheduleConfigProperty ¶
type CfnMonitoringSchedule_ScheduleConfigProperty struct { // A cron expression that describes details about the monitoring schedule. // // The supported cron expressions are: // // - If you want to set the job to start every hour, use the following: // // `Hourly: cron(0 * ? * * *)` // - If you want to start the job daily: // // `cron(0 [00-23] ? * * *)` // - If you want to run the job one time, immediately, use the following keyword: // // `NOW` // // 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. // // You can also specify the keyword `NOW` to run the monitoring job immediately, one time, without recurring. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html#cfn-sagemaker-monitoringschedule-scheduleconfig-scheduleexpression // ScheduleExpression *string `field:"required" json:"scheduleExpression" yaml:"scheduleExpression"` // Sets the end time for a monitoring job window. // // Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the `ScheduleExpression` parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: `"-PT1H"` . // // The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the `DataAnalysisStartTime` parameter. // // If you set `ScheduleExpression` to `NOW` , this parameter is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html#cfn-sagemaker-monitoringschedule-scheduleconfig-dataanalysisendtime // DataAnalysisEndTime *string `field:"optional" json:"dataAnalysisEndTime" yaml:"dataAnalysisEndTime"` // Sets the start time for a monitoring job window. // // Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the `ScheduleExpression` parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: `"-PT5H"` . // // The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the `DataAnalysisEndTime` parameter. // // If you set `ScheduleExpression` to `NOW` , this parameter is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-scheduleconfig.html#cfn-sagemaker-monitoringschedule-scheduleconfig-dataanalysisstarttime // DataAnalysisStartTime *string `field:"optional" json:"dataAnalysisStartTime" yaml:"dataAnalysisStartTime"` }
Configuration details about the monitoring schedule.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scheduleConfigProperty := &ScheduleConfigProperty{ ScheduleExpression: jsii.String("scheduleExpression"), // the properties below are optional DataAnalysisEndTime: jsii.String("dataAnalysisEndTime"), DataAnalysisStartTime: jsii.String("dataAnalysisStartTime"), }
type CfnMonitoringSchedule_StatisticsResourceProperty ¶
type CfnMonitoringSchedule_StatisticsResourceProperty struct { // The S3 URI for the statistics resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-statisticsresource.html#cfn-sagemaker-monitoringschedule-statisticsresource-s3uri // S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"` }
The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statisticsResourceProperty := &StatisticsResourceProperty{ S3Uri: jsii.String("s3Uri"), }
type CfnMonitoringSchedule_StoppingConditionProperty ¶
type CfnMonitoringSchedule_StoppingConditionProperty struct { // The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. // // For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model. // // For all other jobs, if the job does not complete during this time, 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. // // The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-stoppingcondition.html#cfn-sagemaker-monitoringschedule-stoppingcondition-maxruntimeinseconds // MaxRuntimeInSeconds *float64 `field:"required" json:"maxRuntimeInSeconds" yaml:"maxRuntimeInSeconds"` }
Specifies a limit to how long a job can run.
When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
To stop a training job, 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 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stoppingConditionProperty := &StoppingConditionProperty{ MaxRuntimeInSeconds: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-vpcconfig.html#cfn-sagemaker-monitoringschedule-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-monitoringschedule-vpcconfig.html#cfn-sagemaker-monitoringschedule-vpcconfig-subnets // Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"` }
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, Subnets: []*string{ jsii.String("subnets"), }, }
type CfnNotebookInstance ¶
type CfnNotebookInstance interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. AcceleratorTypes() *[]*string SetAcceleratorTypes(val *[]*string) // An array of up to three Git repositories associated with the notebook instance. AdditionalCodeRepositories() *[]*string SetAdditionalCodeRepositories(val *[]*string) AttrId() *string // The name of the notebook instance, such as `MyNotebookInstance` . AttrNotebookInstanceName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Git repository associated with the notebook instance as its default code repository. DefaultCodeRepository() *string SetDefaultCodeRepository(val *string) // Sets whether SageMaker provides internet access to the notebook instance. DirectInternetAccess() *string SetDirectInternetAccess(val *string) // Information on the IMDS configuration of the notebook instance. InstanceMetadataServiceConfiguration() interface{} SetInstanceMetadataServiceConfiguration(val interface{}) // The type of ML compute instance to launch for the notebook instance. InstanceType() *string SetInstanceType(val *string) // The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. KmsKeyId() *string SetKmsKeyId(val *string) // The name of a lifecycle configuration to associate with the notebook instance. LifecycleConfigName() *string SetLifecycleConfigName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The name of the new notebook instance. NotebookInstanceName() *string SetNotebookInstanceName(val *string) // The platform identifier of the notebook instance runtime environment. PlatformIdentifier() *string SetPlatformIdentifier(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. RoleArn() *string SetRoleArn(val *string) // Whether root access is enabled or disabled for users of the notebook instance. // // The default value is `Enabled` . RootAccess() *string SetRootAccess(val *string) // The VPC security group IDs, in the form sg-xxxxxxxx. SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. SubnetId() *string SetSubnetId(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The size, in GB, of the ML storage volume to attach to the notebook instance. VolumeSizeInGb() *float64 SetVolumeSizeInGb(val *float64) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnNotebookInstance := awscdk.Aws_sagemaker.NewCfnNotebookInstance(this, jsii.String("MyCfnNotebookInstance"), &CfnNotebookInstanceProps{ InstanceType: jsii.String("instanceType"), RoleArn: jsii.String("roleArn"), // the properties below are optional AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, AdditionalCodeRepositories: []*string{ jsii.String("additionalCodeRepositories"), }, DefaultCodeRepository: jsii.String("defaultCodeRepository"), DirectInternetAccess: jsii.String("directInternetAccess"), InstanceMetadataServiceConfiguration: &InstanceMetadataServiceConfigurationProperty{ MinimumInstanceMetadataServiceVersion: jsii.String("minimumInstanceMetadataServiceVersion"), }, KmsKeyId: jsii.String("kmsKeyId"), LifecycleConfigName: jsii.String("lifecycleConfigName"), NotebookInstanceName: jsii.String("notebookInstanceName"), PlatformIdentifier: jsii.String("platformIdentifier"), RootAccess: jsii.String("rootAccess"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetId: jsii.String("subnetId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VolumeSizeInGb: jsii.Number(123), })
func NewCfnNotebookInstance ¶
func NewCfnNotebookInstance(scope constructs.Construct, id *string, props *CfnNotebookInstanceProps) CfnNotebookInstance
type CfnNotebookInstanceLifecycleConfig ¶
type CfnNotebookInstanceLifecycleConfig interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The name of the lifecycle configuration, such as `MyLifecycleConfig` . AttrNotebookInstanceLifecycleConfigName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The name of the lifecycle configuration. NotebookInstanceLifecycleConfigName() *string SetNotebookInstanceLifecycleConfigName(val *string) // A shell script that runs only once, when you create a notebook instance. OnCreate() interface{} SetOnCreate(val interface{}) // A shell script that runs every time you start a notebook instance, including when you create the notebook instance. OnStart() interface{} SetOnStart(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnNotebookInstanceLifecycleConfig := awscdk.Aws_sagemaker.NewCfnNotebookInstanceLifecycleConfig(this, jsii.String("MyCfnNotebookInstanceLifecycleConfig"), &CfnNotebookInstanceLifecycleConfigProps{ NotebookInstanceLifecycleConfigName: jsii.String("notebookInstanceLifecycleConfigName"), OnCreate: []interface{}{ &NotebookInstanceLifecycleHookProperty{ Content: jsii.String("content"), }, }, OnStart: []interface{}{ &NotebookInstanceLifecycleHookProperty{ Content: jsii.String("content"), }, }, })
func NewCfnNotebookInstanceLifecycleConfig ¶
func NewCfnNotebookInstanceLifecycleConfig(scope constructs.Construct, id *string, props *CfnNotebookInstanceLifecycleConfigProps) CfnNotebookInstanceLifecycleConfig
type CfnNotebookInstanceLifecycleConfigProps ¶
type CfnNotebookInstanceLifecycleConfigProps struct { // The name of the lifecycle configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html#cfn-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecycleconfigname // NotebookInstanceLifecycleConfigName *string `field:"optional" json:"notebookInstanceLifecycleConfigName" yaml:"notebookInstanceLifecycleConfigName"` // A shell script that runs only once, when you create a notebook instance. // // The shell script must be a base64-encoded string. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html#cfn-sagemaker-notebookinstancelifecycleconfig-oncreate // OnCreate interface{} `field:"optional" json:"onCreate" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstancelifecycleconfig.html#cfn-sagemaker-notebookinstancelifecycleconfig-onstart // OnStart interface{} `field:"optional" json:"onStart" yaml:"onStart"` }
Properties for defining a `CfnNotebookInstanceLifecycleConfig`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnNotebookInstanceLifecycleConfigProps := &CfnNotebookInstanceLifecycleConfigProps{ NotebookInstanceLifecycleConfigName: jsii.String("notebookInstanceLifecycleConfigName"), OnCreate: []interface{}{ &NotebookInstanceLifecycleHookProperty{ Content: jsii.String("content"), }, }, OnStart: []interface{}{ &NotebookInstanceLifecycleHookProperty{ Content: jsii.String("content"), }, }, }
type CfnNotebookInstanceLifecycleConfig_NotebookInstanceLifecycleHookProperty ¶
type CfnNotebookInstanceLifecycleConfig_NotebookInstanceLifecycleHookProperty struct { // A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecyclehook.html#cfn-sagemaker-notebookinstancelifecycleconfig-notebookinstancelifecyclehook-content // Content *string `field:"optional" json:"content" yaml:"content"` }
Specifies the notebook instance lifecycle configuration script.
Each lifecycle configuration script has a limit of 16384 characters.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" notebookInstanceLifecycleHookProperty := &NotebookInstanceLifecycleHookProperty{ Content: jsii.String("content"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. // // You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see [SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) . // // > To be able to pass this role to SageMaker, the caller of this API must have the `iam:PassRole` permission. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes // AcceleratorTypes *[]*string `field:"optional" json:"acceleratorTypes" yaml:"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 SageMaker Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories // AdditionalCodeRepositories *[]*string `field:"optional" json:"additionalCodeRepositories" yaml:"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 SageMaker Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository // DefaultCodeRepository *string `field:"optional" json:"defaultCodeRepository" yaml:"defaultCodeRepository"` // Sets whether 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 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess // DirectInternetAccess *string `field:"optional" json:"directInternetAccess" yaml:"directInternetAccess"` // Information on the IMDS configuration of the notebook instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration // InstanceMetadataServiceConfiguration interface{} `field:"optional" json:"instanceMetadataServiceConfiguration" yaml:"instanceMetadataServiceConfiguration"` // The Amazon Resource Name (ARN) of a AWS Key Management Service key that 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname // LifecycleConfigName *string `field:"optional" json:"lifecycleConfigName" yaml:"lifecycleConfigName"` // The name of the new notebook instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename // NotebookInstanceName *string `field:"optional" json:"notebookInstanceName" yaml:"notebookInstanceName"` // The platform identifier of the notebook instance runtime environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-platformidentifier // PlatformIdentifier *string `field:"optional" json:"platformIdentifier" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess // RootAccess *string `field:"optional" json:"rootAccess" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids // SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"` // The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid // SubnetId *string `field:"optional" json:"subnetId" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb // VolumeSizeInGb *float64 `field:"optional" json:"volumeSizeInGb" yaml:"volumeSizeInGb"` }
Properties for defining a `CfnNotebookInstance`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnNotebookInstanceProps := &CfnNotebookInstanceProps{ InstanceType: jsii.String("instanceType"), RoleArn: jsii.String("roleArn"), // the properties below are optional AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, AdditionalCodeRepositories: []*string{ jsii.String("additionalCodeRepositories"), }, DefaultCodeRepository: jsii.String("defaultCodeRepository"), DirectInternetAccess: jsii.String("directInternetAccess"), InstanceMetadataServiceConfiguration: &InstanceMetadataServiceConfigurationProperty{ MinimumInstanceMetadataServiceVersion: jsii.String("minimumInstanceMetadataServiceVersion"), }, KmsKeyId: jsii.String("kmsKeyId"), LifecycleConfigName: jsii.String("lifecycleConfigName"), NotebookInstanceName: jsii.String("notebookInstanceName"), PlatformIdentifier: jsii.String("platformIdentifier"), RootAccess: jsii.String("rootAccess"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetId: jsii.String("subnetId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VolumeSizeInGb: jsii.Number(123), }
type CfnNotebookInstance_InstanceMetadataServiceConfigurationProperty ¶ added in v2.45.0
type CfnNotebookInstance_InstanceMetadataServiceConfigurationProperty struct { // Indicates the minimum IMDS version that the notebook instance supports. // // When passed as part of `CreateNotebookInstance` , if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of `UpdateNotebookInstance` , there is no default. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-notebookinstance-instancemetadataserviceconfiguration.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration-minimuminstancemetadataserviceversion // MinimumInstanceMetadataServiceVersion *string `field:"required" json:"minimumInstanceMetadataServiceVersion" yaml:"minimumInstanceMetadataServiceVersion"` }
Information on the IMDS configuration of the notebook instance.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" instanceMetadataServiceConfigurationProperty := &InstanceMetadataServiceConfigurationProperty{ MinimumInstanceMetadataServiceVersion: jsii.String("minimumInstanceMetadataServiceVersion"), }
type CfnPipeline ¶
type CfnPipeline interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The parallelism configuration applied to the pipeline. ParallelismConfiguration() interface{} SetParallelismConfiguration(val interface{}) // The definition of the pipeline. PipelineDefinition() interface{} SetPipelineDefinition(val interface{}) // The description of the pipeline. PipelineDescription() *string SetPipelineDescription(val *string) // The display name of the pipeline. PipelineDisplayName() *string SetPipelineDisplayName(val *string) // The name of the pipeline. PipelineName() *string SetPipelineName(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags of the pipeline. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var parallelismConfiguration interface{} var pipelineDefinition interface{} cfnPipeline := awscdk.Aws_sagemaker.NewCfnPipeline(this, jsii.String("MyCfnPipeline"), &CfnPipelineProps{ PipelineDefinition: pipelineDefinition, PipelineName: jsii.String("pipelineName"), RoleArn: jsii.String("roleArn"), // the properties below are optional ParallelismConfiguration: parallelismConfiguration, PipelineDescription: jsii.String("pipelineDescription"), PipelineDisplayName: jsii.String("pipelineDisplayName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html
func NewCfnPipeline ¶
func NewCfnPipeline(scope constructs.Construct, id *string, props *CfnPipelineProps) CfnPipeline
type CfnPipelineProps ¶
type CfnPipelineProps struct { // The definition of the pipeline. // // This can be either a JSON string or an Amazon S3 location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinedefinition // PipelineDefinition interface{} `field:"required" json:"pipelineDefinition" yaml:"pipelineDefinition"` // The name of the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinename // PipelineName *string `field:"required" json:"pipelineName" yaml:"pipelineName"` // The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The parallelism configuration applied to the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-parallelismconfiguration // ParallelismConfiguration interface{} `field:"optional" json:"parallelismConfiguration" yaml:"parallelismConfiguration"` // The description of the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinedescription // PipelineDescription *string `field:"optional" json:"pipelineDescription" yaml:"pipelineDescription"` // The display name of the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinedisplayname // PipelineDisplayName *string `field:"optional" json:"pipelineDisplayName" yaml:"pipelineDisplayName"` // The tags of the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnPipeline`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var parallelismConfiguration interface{} var pipelineDefinition interface{} cfnPipelineProps := &CfnPipelineProps{ PipelineDefinition: pipelineDefinition, PipelineName: jsii.String("pipelineName"), RoleArn: jsii.String("roleArn"), // the properties below are optional ParallelismConfiguration: parallelismConfiguration, PipelineDescription: jsii.String("pipelineDescription"), PipelineDisplayName: jsii.String("pipelineDisplayName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html
type CfnPipeline_ParallelismConfigurationProperty ¶ added in v2.55.0
type CfnPipeline_ParallelismConfigurationProperty struct { // The max number of steps that can be executed in parallel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-parallelismconfiguration.html#cfn-sagemaker-pipeline-parallelismconfiguration-maxparallelexecutionsteps // MaxParallelExecutionSteps *float64 `field:"required" json:"maxParallelExecutionSteps" yaml:"maxParallelExecutionSteps"` }
Configuration that controls the parallelism of the pipeline.
By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" parallelismConfigurationProperty := &ParallelismConfigurationProperty{ MaxParallelExecutionSteps: jsii.Number(123), }
type CfnPipeline_PipelineDefinitionProperty ¶ added in v2.55.0
type CfnPipeline_PipelineDefinitionProperty struct { // The [JSON pipeline definition](https://docs.aws.amazon.com/https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/) of the pipeline. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-pipelinedefinition.html#cfn-sagemaker-pipeline-pipelinedefinition-pipelinedefinitionbody // PipelineDefinitionBody *string `field:"required" json:"pipelineDefinitionBody" yaml:"pipelineDefinitionBody"` // The location of the pipeline definition stored in Amazon S3. // // If specified, SageMaker retrieves the pipeline definition from this location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-pipelinedefinition.html#cfn-sagemaker-pipeline-pipelinedefinition-pipelinedefinitions3location // PipelineDefinitionS3Location interface{} `field:"optional" json:"pipelineDefinitionS3Location" yaml:"pipelineDefinitionS3Location"` }
The definition of the pipeline.
This can be either a JSON string or an Amazon S3 location.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" pipelineDefinitionProperty := &PipelineDefinitionProperty{ PipelineDefinitionBody: jsii.String("pipelineDefinitionBody"), // the properties below are optional PipelineDefinitionS3Location: &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), // the properties below are optional ETag: jsii.String("eTag"), Version: jsii.String("version"), }, }
type CfnPipeline_S3LocationProperty ¶ added in v2.55.0
type CfnPipeline_S3LocationProperty struct { // The name of the S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // The object key (or key name) which uniquely identifies the object in an S3 bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-key // Key *string `field:"required" json:"key" yaml:"key"` // A file checksum of the pipeline definition file. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-etag // ETag *string `field:"optional" json:"eTag" yaml:"eTag"` // The version ID of the pipeline definition file. // // If not specified, Amazon SageMaker will retrieve the latest version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-version // Version *string `field:"optional" json:"version" yaml:"version"` }
The location of the pipeline definition stored in Amazon S3.
If specified, SageMaker will retrieve the pipeline definition from this location.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), // the properties below are optional ETag: jsii.String("eTag"), Version: jsii.String("version"), }
type CfnProject ¶
type CfnProject interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The time that the project was created. AttrCreationTime() *string // The Amazon Resource Name (ARN) of the project. AttrProjectArn() *string // The ID of the project. // // This ID is prepended to all entities associated with this project. AttrProjectId() *string // The status of the project. AttrProjectStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The description of the project. ProjectDescription() *string SetProjectDescription(val *string) // The name of the project. ProjectName() *string SetProjectName(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Details of a provisioned service catalog product. ServiceCatalogProvisionedProductDetails() interface{} SetServiceCatalogProvisionedProductDetails(val interface{}) // The product ID and provisioning artifact ID to provision a service catalog. ServiceCatalogProvisioningDetails() interface{} SetServiceCatalogProvisioningDetails(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var serviceCatalogProvisioningDetails interface{} cfnProject := awscdk.Aws_sagemaker.NewCfnProject(this, jsii.String("MyCfnProject"), &CfnProjectProps{ ProjectName: jsii.String("projectName"), ServiceCatalogProvisioningDetails: serviceCatalogProvisioningDetails, // the properties below are optional ProjectDescription: jsii.String("projectDescription"), ServiceCatalogProvisionedProductDetails: &ServiceCatalogProvisionedProductDetailsProperty{ ProvisionedProductId: jsii.String("provisionedProductId"), ProvisionedProductStatusMessage: jsii.String("provisionedProductStatusMessage"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html
func NewCfnProject ¶
func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject
type CfnProjectProps ¶
type CfnProjectProps struct { // The name of the project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-projectname // ProjectName *string `field:"required" json:"projectName" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-servicecatalogprovisioningdetails // ServiceCatalogProvisioningDetails interface{} `field:"required" json:"serviceCatalogProvisioningDetails" yaml:"serviceCatalogProvisioningDetails"` // The description of the project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-projectdescription // ProjectDescription *string `field:"optional" json:"projectDescription" yaml:"projectDescription"` // Details of a provisioned service catalog product. // // For information about service catalog, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-servicecatalogprovisionedproductdetails // ServiceCatalogProvisionedProductDetails interface{} `field:"optional" json:"serviceCatalogProvisionedProductDetails" yaml:"serviceCatalogProvisionedProductDetails"` // 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html#cfn-sagemaker-project-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnProject`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var serviceCatalogProvisioningDetails interface{} cfnProjectProps := &CfnProjectProps{ ProjectName: jsii.String("projectName"), ServiceCatalogProvisioningDetails: serviceCatalogProvisioningDetails, // the properties below are optional ProjectDescription: jsii.String("projectDescription"), ServiceCatalogProvisionedProductDetails: &ServiceCatalogProvisionedProductDetailsProperty{ ProvisionedProductId: jsii.String("provisionedProductId"), ProvisionedProductStatusMessage: jsii.String("provisionedProductStatusMessage"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html
type CfnProject_ProvisioningParameterProperty ¶ added in v2.55.0
type CfnProject_ProvisioningParameterProperty struct { // The key that identifies a provisioning parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-provisioningparameter.html#cfn-sagemaker-project-provisioningparameter-key // Key *string `field:"required" json:"key" yaml:"key"` // The value of the provisioning parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-provisioningparameter.html#cfn-sagemaker-project-provisioningparameter-value // Value *string `field:"required" json:"value" yaml:"value"` }
A key value pair used when you provision a project as a service catalog product.
For information, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" provisioningParameterProperty := &ProvisioningParameterProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }
type CfnProject_ServiceCatalogProvisionedProductDetailsProperty ¶ added in v2.55.0
type CfnProject_ServiceCatalogProvisionedProductDetailsProperty struct { // The ID of the provisioned product. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisionedproductdetails.html#cfn-sagemaker-project-servicecatalogprovisionedproductdetails-provisionedproductid // ProvisionedProductId *string `field:"optional" json:"provisionedProductId" yaml:"provisionedProductId"` // The current status of the product. // // - `AVAILABLE` - Stable state, ready to perform any operation. The most recent operation succeeded and completed. // - `UNDER_CHANGE` - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations. // - `TAINTED` - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. // - `ERROR` - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack. // - `PLAN_IN_PROGRESS` - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisionedproductdetails.html#cfn-sagemaker-project-servicecatalogprovisionedproductdetails-provisionedproductstatusmessage // ProvisionedProductStatusMessage *string `field:"optional" json:"provisionedProductStatusMessage" yaml:"provisionedProductStatusMessage"` }
Details of a provisioned service catalog product.
For information about service catalog, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serviceCatalogProvisionedProductDetailsProperty := &ServiceCatalogProvisionedProductDetailsProperty{ ProvisionedProductId: jsii.String("provisionedProductId"), ProvisionedProductStatusMessage: jsii.String("provisionedProductStatusMessage"), }
type CfnProject_ServiceCatalogProvisioningDetailsProperty ¶ added in v2.55.0
type CfnProject_ServiceCatalogProvisioningDetailsProperty struct { // The ID of the product to provision. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-productid // ProductId *string `field:"required" json:"productId" yaml:"productId"` // The path identifier of the product. // // This value is optional if the product has a default path, and required if the product has more than one path. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-pathid // PathId *string `field:"optional" json:"pathId" yaml:"pathId"` // The ID of the provisioning artifact. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-provisioningartifactid // ProvisioningArtifactId *string `field:"optional" json:"provisioningArtifactId" yaml:"provisioningArtifactId"` // A list of key value pairs that you specify when you provision a product. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-provisioningparameters // ProvisioningParameters interface{} `field:"optional" json:"provisioningParameters" yaml:"provisioningParameters"` }
Details that you specify to provision a service catalog product.
For information about service catalog, see [What is AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serviceCatalogProvisioningDetailsProperty := &ServiceCatalogProvisioningDetailsProperty{ ProductId: jsii.String("productId"), // the properties below are optional PathId: jsii.String("pathId"), ProvisioningArtifactId: jsii.String("provisioningArtifactId"), ProvisioningParameters: []interface{}{ &ProvisioningParameterProperty{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnSpace ¶ added in v2.70.0
type CfnSpace interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The space's Amazon Resource Name (ARN). AttrSpaceArn() *string // Returns the URL of the space. // // If the space is created with AWS IAM Identity Center (Successor to AWS Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through AWS IAM Identity Center. // // The following application types are supported: // // - Studio Classic: `&redirect=JupyterServer` // - JupyterLab: `&redirect=JupyterLab` // - Code Editor, based on Code-OSS, Visual Studio Code - Open Source: `&redirect=CodeEditor`. AttrUrl() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The ID of the associated domain. DomainId() *string SetDomainId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The collection of ownership settings for a space. OwnershipSettings() interface{} SetOwnershipSettings(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The name of the space that appears in the Studio UI. SpaceDisplayName() *string SetSpaceDisplayName(val *string) // The name of the space. SpaceName() *string SetSpaceName(val *string) // A collection of space settings. SpaceSettings() interface{} SetSpaceSettings(val interface{}) // A collection of space sharing settings. SpaceSharingSettings() interface{} SetSpaceSharingSettings(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a private space or a space used for real time collaboration in a domain.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSpace := awscdk.Aws_sagemaker.NewCfnSpace(this, jsii.String("MyCfnSpace"), &CfnSpaceProps{ DomainId: jsii.String("domainId"), SpaceName: jsii.String("spaceName"), // the properties below are optional OwnershipSettings: &OwnershipSettingsProperty{ OwnerUserProfileName: jsii.String("ownerUserProfileName"), }, SpaceDisplayName: jsii.String("spaceDisplayName"), SpaceSettings: &SpaceSettingsProperty{ AppType: jsii.String("appType"), CodeEditorAppSettings: &SpaceCodeEditorAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, CustomFileSystems: []interface{}{ &CustomFileSystemProperty{ EfsFileSystem: &EFSFileSystemProperty{ FileSystemId: jsii.String("fileSystemId"), }, }, }, JupyterLabAppSettings: &SpaceJupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, SpaceStorageSettings: &SpaceStorageSettingsProperty{ EbsStorageSettings: &EbsStorageSettingsProperty{ EbsVolumeSizeInGb: jsii.Number(123), }, }, }, SpaceSharingSettings: &SpaceSharingSettingsProperty{ SharingType: jsii.String("sharingType"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html
func NewCfnSpace ¶ added in v2.70.0
func NewCfnSpace(scope constructs.Construct, id *string, props *CfnSpaceProps) CfnSpace
type CfnSpaceProps ¶ added in v2.70.0
type CfnSpaceProps struct { // The ID of the associated domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-domainid // DomainId *string `field:"required" json:"domainId" yaml:"domainId"` // The name of the space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacename // SpaceName *string `field:"required" json:"spaceName" yaml:"spaceName"` // The collection of ownership settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-ownershipsettings // OwnershipSettings interface{} `field:"optional" json:"ownershipSettings" yaml:"ownershipSettings"` // The name of the space that appears in the Studio UI. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacedisplayname // SpaceDisplayName *string `field:"optional" json:"spaceDisplayName" yaml:"spaceDisplayName"` // A collection of space settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacesettings // SpaceSettings interface{} `field:"optional" json:"spaceSettings" yaml:"spaceSettings"` // A collection of space sharing settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacesharingsettings // SpaceSharingSettings interface{} `field:"optional" json:"spaceSharingSettings" yaml:"spaceSharingSettings"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSpace`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSpaceProps := &CfnSpaceProps{ DomainId: jsii.String("domainId"), SpaceName: jsii.String("spaceName"), // the properties below are optional OwnershipSettings: &OwnershipSettingsProperty{ OwnerUserProfileName: jsii.String("ownerUserProfileName"), }, SpaceDisplayName: jsii.String("spaceDisplayName"), SpaceSettings: &SpaceSettingsProperty{ AppType: jsii.String("appType"), CodeEditorAppSettings: &SpaceCodeEditorAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, CustomFileSystems: []interface{}{ &CustomFileSystemProperty{ EfsFileSystem: &EFSFileSystemProperty{ FileSystemId: jsii.String("fileSystemId"), }, }, }, JupyterLabAppSettings: &SpaceJupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, SpaceStorageSettings: &SpaceStorageSettingsProperty{ EbsStorageSettings: &EbsStorageSettingsProperty{ EbsVolumeSizeInGb: jsii.Number(123), }, }, }, SpaceSharingSettings: &SpaceSharingSettingsProperty{ SharingType: jsii.String("sharingType"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html
type CfnSpace_CodeRepositoryProperty ¶ added in v2.127.0
type CfnSpace_CodeRepositoryProperty struct { // The URL of the Git repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-coderepository.html#cfn-sagemaker-space-coderepository-repositoryurl // RepositoryUrl *string `field:"required" json:"repositoryUrl" yaml:"repositoryUrl"` }
A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" codeRepositoryProperty := &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }
type CfnSpace_CustomFileSystemProperty ¶ added in v2.127.0
type CfnSpace_CustomFileSystemProperty struct { // A custom file system in Amazon EFS. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customfilesystem.html#cfn-sagemaker-space-customfilesystem-efsfilesystem // EfsFileSystem interface{} `field:"optional" json:"efsFileSystem" yaml:"efsFileSystem"` }
A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain.
Permitted users can access this file system in Amazon SageMaker Studio.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customFileSystemProperty := &CustomFileSystemProperty{ EfsFileSystem: &EFSFileSystemProperty{ FileSystemId: jsii.String("fileSystemId"), }, }
type CfnSpace_CustomImageProperty ¶ added in v2.70.0
type CfnSpace_CustomImageProperty struct { // The name of the AppImageConfig. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.html#cfn-sagemaker-space-customimage-appimageconfigname // AppImageConfigName *string `field:"required" json:"appImageConfigName" yaml:"appImageConfigName"` // The name of the CustomImage. // // Must be unique to your account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.html#cfn-sagemaker-space-customimage-imagename // ImageName *string `field:"required" json:"imageName" yaml:"imageName"` // The version number of the CustomImage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.html#cfn-sagemaker-space-customimage-imageversionnumber // ImageVersionNumber *float64 `field:"optional" json:"imageVersionNumber" yaml:"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) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customImageProperty := &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }
type CfnSpace_EFSFileSystemProperty ¶ added in v2.127.0
type CfnSpace_EFSFileSystemProperty struct { // The ID of your Amazon EFS file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-efsfilesystem.html#cfn-sagemaker-space-efsfilesystem-filesystemid // FileSystemId *string `field:"required" json:"fileSystemId" yaml:"fileSystemId"` }
A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker Domain.
Permitted users can access this file system in Amazon SageMaker Studio.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eFSFileSystemProperty := &EFSFileSystemProperty{ FileSystemId: jsii.String("fileSystemId"), }
type CfnSpace_EbsStorageSettingsProperty ¶ added in v2.127.0
type CfnSpace_EbsStorageSettingsProperty struct { // The size of an EBS storage volume for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-ebsstoragesettings.html#cfn-sagemaker-space-ebsstoragesettings-ebsvolumesizeingb // EbsVolumeSizeInGb *float64 `field:"required" json:"ebsVolumeSizeInGb" yaml:"ebsVolumeSizeInGb"` }
A collection of EBS storage settings that apply to both private and shared spaces.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ebsStorageSettingsProperty := &EbsStorageSettingsProperty{ EbsVolumeSizeInGb: jsii.Number(123), }
type CfnSpace_JupyterServerAppSettingsProperty ¶ added in v2.70.0
type CfnSpace_JupyterServerAppSettingsProperty struct { // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. // // If you use the `LifecycleConfigArns` parameter, then this parameter is also required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-jupyterserverappsettings.html#cfn-sagemaker-space-jupyterserverappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. // // If you use this parameter, the `DefaultResourceSpec` parameter is also required. // // > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-jupyterserverappsettings.html#cfn-sagemaker-space-jupyterserverappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The JupyterServer app settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jupyterServerAppSettingsProperty := &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnSpace_KernelGatewayAppSettingsProperty ¶ added in v2.70.0
type CfnSpace_KernelGatewayAppSettingsProperty struct { // A list of custom SageMaker images that are configured to run as a KernelGateway app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.html#cfn-sagemaker-space-kernelgatewayappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. // // > The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or AWS CloudFormation and the instance type parameter value is not passed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.html#cfn-sagemaker-space-kernelgatewayappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain. // // > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.html#cfn-sagemaker-space-kernelgatewayappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The KernelGateway app settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kernelGatewayAppSettingsProperty := &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnSpace_OwnershipSettingsProperty ¶ added in v2.127.0
type CfnSpace_OwnershipSettingsProperty struct { // The user profile who is the owner of the space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-ownershipsettings.html#cfn-sagemaker-space-ownershipsettings-owneruserprofilename // OwnerUserProfileName *string `field:"required" json:"ownerUserProfileName" yaml:"ownerUserProfileName"` }
The collection of ownership settings for a space.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ownershipSettingsProperty := &OwnershipSettingsProperty{ OwnerUserProfileName: jsii.String("ownerUserProfileName"), }
type CfnSpace_ResourceSpecProperty ¶ added in v2.70.0
type CfnSpace_ResourceSpecProperty struct { // The instance type that the image version runs on. // // > *JupyterServer apps* only support the `system` value. // > // > For *KernelGateway apps* , the `system` value is translated to `ml.t3.medium` . KernelGateway apps also support all other values for available instance types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-instancetype // InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"` // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-lifecycleconfigarn // LifecycleConfigArn *string `field:"optional" json:"lifecycleConfigArn" yaml:"lifecycleConfigArn"` // The ARN of the SageMaker image that the image version belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-sagemakerimagearn // SageMakerImageArn *string `field:"optional" json:"sageMakerImageArn" yaml:"sageMakerImageArn"` // The ARN of the image version created on the instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-sagemakerimageversionarn // SageMakerImageVersionArn *string `field:"optional" json:"sageMakerImageVersionArn" yaml:"sageMakerImageVersionArn"` }
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" resourceSpecProperty := &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }
type CfnSpace_SpaceCodeEditorAppSettingsProperty ¶ added in v2.127.0
type CfnSpace_SpaceCodeEditorAppSettingsProperty struct { // Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.html#cfn-sagemaker-space-spacecodeeditorappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` }
The application settings for a Code Editor space.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spaceCodeEditorAppSettingsProperty := &SpaceCodeEditorAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }
type CfnSpace_SpaceJupyterLabAppSettingsProperty ¶ added in v2.127.0
type CfnSpace_SpaceJupyterLabAppSettingsProperty struct { // A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-coderepositories // CodeRepositories interface{} `field:"optional" json:"codeRepositories" yaml:"codeRepositories"` // Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` }
The settings for the JupyterLab application within a space.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spaceJupyterLabAppSettingsProperty := &SpaceJupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }
type CfnSpace_SpaceSettingsProperty ¶ added in v2.70.0
type CfnSpace_SpaceSettingsProperty struct { // The type of app created within the space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-apptype // AppType *string `field:"optional" json:"appType" yaml:"appType"` // The Code Editor application settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-codeeditorappsettings // CodeEditorAppSettings interface{} `field:"optional" json:"codeEditorAppSettings" yaml:"codeEditorAppSettings"` // A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. // // Permitted users can access this file system in Amazon SageMaker Studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-customfilesystems // CustomFileSystems interface{} `field:"optional" json:"customFileSystems" yaml:"customFileSystems"` // The settings for the JupyterLab application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterlabappsettings // JupyterLabAppSettings interface{} `field:"optional" json:"jupyterLabAppSettings" yaml:"jupyterLabAppSettings"` // The JupyterServer app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterserverappsettings // JupyterServerAppSettings interface{} `field:"optional" json:"jupyterServerAppSettings" yaml:"jupyterServerAppSettings"` // The KernelGateway app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-kernelgatewayappsettings // KernelGatewayAppSettings interface{} `field:"optional" json:"kernelGatewayAppSettings" yaml:"kernelGatewayAppSettings"` // The storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacestoragesettings // SpaceStorageSettings interface{} `field:"optional" json:"spaceStorageSettings" yaml:"spaceStorageSettings"` }
A collection of space settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spaceSettingsProperty := &SpaceSettingsProperty{ AppType: jsii.String("appType"), CodeEditorAppSettings: &SpaceCodeEditorAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, CustomFileSystems: []interface{}{ &CustomFileSystemProperty{ EfsFileSystem: &EFSFileSystemProperty{ FileSystemId: jsii.String("fileSystemId"), }, }, }, JupyterLabAppSettings: &SpaceJupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, SpaceStorageSettings: &SpaceStorageSettingsProperty{ EbsStorageSettings: &EbsStorageSettingsProperty{ EbsVolumeSizeInGb: jsii.Number(123), }, }, }
type CfnSpace_SpaceSharingSettingsProperty ¶ added in v2.127.0
type CfnSpace_SpaceSharingSettingsProperty struct { // Specifies the sharing type of the space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesharingsettings.html#cfn-sagemaker-space-spacesharingsettings-sharingtype // SharingType *string `field:"required" json:"sharingType" yaml:"sharingType"` }
A collection of space sharing settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spaceSharingSettingsProperty := &SpaceSharingSettingsProperty{ SharingType: jsii.String("sharingType"), }
type CfnSpace_SpaceStorageSettingsProperty ¶ added in v2.127.0
type CfnSpace_SpaceStorageSettingsProperty struct { // A collection of EBS storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacestoragesettings.html#cfn-sagemaker-space-spacestoragesettings-ebsstoragesettings // EbsStorageSettings interface{} `field:"optional" json:"ebsStorageSettings" yaml:"ebsStorageSettings"` }
The storage settings for a space.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spaceStorageSettingsProperty := &SpaceStorageSettingsProperty{ EbsStorageSettings: &EbsStorageSettingsProperty{ EbsVolumeSizeInGb: jsii.Number(123), }, }
type CfnStudioLifecycleConfig ¶ added in v2.154.0
type CfnStudioLifecycleConfig interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the Lifecycle Configuration. AttrStudioLifecycleConfigArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The App type to which the Lifecycle Configuration is attached. StudioLifecycleConfigAppType() *string SetStudioLifecycleConfigAppType(val *string) // The content of your Amazon SageMaker Studio Lifecycle Configuration script. StudioLifecycleConfigContent() *string SetStudioLifecycleConfigContent(val *string) // The name of the Amazon SageMaker Studio Lifecycle Configuration. StudioLifecycleConfigName() *string SetStudioLifecycleConfigName(val *string) // Tags to be associated with the Lifecycle Configuration. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new Amazon SageMaker Studio Lifecycle Configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStudioLifecycleConfig := awscdk.Aws_sagemaker.NewCfnStudioLifecycleConfig(this, jsii.String("MyCfnStudioLifecycleConfig"), &CfnStudioLifecycleConfigProps{ StudioLifecycleConfigAppType: jsii.String("studioLifecycleConfigAppType"), StudioLifecycleConfigContent: jsii.String("studioLifecycleConfigContent"), StudioLifecycleConfigName: jsii.String("studioLifecycleConfigName"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnStudioLifecycleConfig ¶ added in v2.154.0
func NewCfnStudioLifecycleConfig(scope constructs.Construct, id *string, props *CfnStudioLifecycleConfigProps) CfnStudioLifecycleConfig
type CfnStudioLifecycleConfigProps ¶ added in v2.154.0
type CfnStudioLifecycleConfigProps struct { // The App type to which the Lifecycle Configuration is attached. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html#cfn-sagemaker-studiolifecycleconfig-studiolifecycleconfigapptype // StudioLifecycleConfigAppType *string `field:"required" json:"studioLifecycleConfigAppType" yaml:"studioLifecycleConfigAppType"` // The content of your Amazon SageMaker Studio Lifecycle Configuration script. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html#cfn-sagemaker-studiolifecycleconfig-studiolifecycleconfigcontent // StudioLifecycleConfigContent *string `field:"required" json:"studioLifecycleConfigContent" yaml:"studioLifecycleConfigContent"` // The name of the Amazon SageMaker Studio Lifecycle Configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html#cfn-sagemaker-studiolifecycleconfig-studiolifecycleconfigname // StudioLifecycleConfigName *string `field:"required" json:"studioLifecycleConfigName" yaml:"studioLifecycleConfigName"` // Tags to be associated with the Lifecycle Configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html#cfn-sagemaker-studiolifecycleconfig-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnStudioLifecycleConfig`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStudioLifecycleConfigProps := &CfnStudioLifecycleConfigProps{ StudioLifecycleConfigAppType: jsii.String("studioLifecycleConfigAppType"), StudioLifecycleConfigContent: jsii.String("studioLifecycleConfigContent"), StudioLifecycleConfigName: jsii.String("studioLifecycleConfigName"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnUserProfile ¶
type CfnUserProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the user profile, such as `arn:aws:sagemaker:region:account-id:user-profile/domain-id/user-profile-name` . AttrUserProfileArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The domain ID. DomainId() *string SetDomainId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // A specifier for the type of value specified in SingleSignOnUserValue. SingleSignOnUserIdentifier() *string SetSingleSignOnUserIdentifier(val *string) // The username of the associated AWS Single Sign-On User for this UserProfile. SingleSignOnUserValue() *string SetSingleSignOnUserValue(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The user profile name. UserProfileName() *string SetUserProfileName(val *string) // A collection of settings that apply to users of Amazon SageMaker Studio. UserSettings() interface{} SetUserSettings(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 IAM Identity Center , 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.
> If you're using IAM Identity Center authentication, a user in IAM Identity Center , or a group in IAM Identity Center containing that user, must be assigned to the Amazon SageMaker Studio application from the IAM Identity Center Console to create a user profile. For more information about application assignment, see [Assign user access](https://docs.aws.amazon.com/singlesignon/latest/userguide/assignuserstoapp.html) . After assignment is complete, a user profile can be created for that user in IAM Identity Center with AWS CloudFormation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnUserProfile := awscdk.Aws_sagemaker.NewCfnUserProfile(this, jsii.String("MyCfnUserProfile"), &CfnUserProfileProps{ DomainId: jsii.String("domainId"), UserProfileName: jsii.String("userProfileName"), // the properties below are optional SingleSignOnUserIdentifier: jsii.String("singleSignOnUserIdentifier"), SingleSignOnUserValue: jsii.String("singleSignOnUserValue"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UserSettings: &UserSettingsProperty{ CodeEditorAppSettings: &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, DefaultLandingUri: jsii.String("defaultLandingUri"), ExecutionRole: jsii.String("executionRole"), JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SharingSettings: &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, StudioWebPortal: jsii.String("studioWebPortal"), StudioWebPortalSettings: &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }, }, })
func NewCfnUserProfile ¶
func NewCfnUserProfile(scope constructs.Construct, id *string, props *CfnUserProfileProps) CfnUserProfile
type CfnUserProfileProps ¶
type CfnUserProfileProps struct { // The domain ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-domainid // DomainId *string `field:"required" json:"domainId" yaml:"domainId"` // The user profile name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-userprofilename // UserProfileName *string `field:"required" json:"userProfileName" yaml:"userProfileName"` // A specifier for the type of value specified in SingleSignOnUserValue. // // Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center , this field is required. If the Domain's AuthMode is not IAM Identity Center , this field cannot be specified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-singlesignonuseridentifier // SingleSignOnUserIdentifier *string `field:"optional" json:"singleSignOnUserIdentifier" yaml:"singleSignOnUserIdentifier"` // The username of the associated AWS Single Sign-On User for this UserProfile. // // If the Domain's AuthMode is IAM Identity Center , this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center , this field cannot be specified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-singlesignonuservalue // SingleSignOnUserValue *string `field:"optional" json:"singleSignOnUserValue" yaml:"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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // A collection of settings that apply to users of Amazon SageMaker Studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-usersettings // UserSettings interface{} `field:"optional" json:"userSettings" yaml:"userSettings"` }
Properties for defining a `CfnUserProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnUserProfileProps := &CfnUserProfileProps{ DomainId: jsii.String("domainId"), UserProfileName: jsii.String("userProfileName"), // the properties below are optional SingleSignOnUserIdentifier: jsii.String("singleSignOnUserIdentifier"), SingleSignOnUserValue: jsii.String("singleSignOnUserValue"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UserSettings: &UserSettingsProperty{ CodeEditorAppSettings: &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, DefaultLandingUri: jsii.String("defaultLandingUri"), ExecutionRole: jsii.String("executionRole"), JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SharingSettings: &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, StudioWebPortal: jsii.String("studioWebPortal"), StudioWebPortalSettings: &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }, }, }
type CfnUserProfile_CodeEditorAppSettingsProperty ¶ added in v2.114.0
type CfnUserProfile_CodeEditorAppSettingsProperty struct { // A list of custom SageMaker images that are configured to run as a Code Editor app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the Code Editor app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The Code Editor application settings.
For more information about Code Editor, see [Get started with Code Editor in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" codeEditorAppSettingsProperty := &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnUserProfile_CodeRepositoryProperty ¶ added in v2.114.0
type CfnUserProfile_CodeRepositoryProperty struct { // The URL of the Git repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-coderepository.html#cfn-sagemaker-userprofile-coderepository-repositoryurl // RepositoryUrl *string `field:"required" json:"repositoryUrl" yaml:"repositoryUrl"` }
A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" codeRepositoryProperty := &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }
type CfnUserProfile_CustomFileSystemConfigProperty ¶ added in v2.114.0
type CfnUserProfile_CustomFileSystemConfigProperty struct { // The settings for a custom Amazon EFS file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customfilesystemconfig.html#cfn-sagemaker-userprofile-customfilesystemconfig-efsfilesystemconfig // EfsFileSystemConfig interface{} `field:"optional" json:"efsFileSystemConfig" yaml:"efsFileSystemConfig"` }
The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain.
Permitted users can access this file system in Amazon SageMaker Studio.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customFileSystemConfigProperty := &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }
type CfnUserProfile_CustomImageProperty ¶
type CfnUserProfile_CustomImageProperty struct { // The name of the AppImageConfig. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html#cfn-sagemaker-userprofile-customimage-appimageconfigname // AppImageConfigName *string `field:"required" json:"appImageConfigName" yaml:"appImageConfigName"` // The name of the CustomImage. // // Must be unique to your account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html#cfn-sagemaker-userprofile-customimage-imagename // ImageName *string `field:"required" json:"imageName" yaml:"imageName"` // The version number of the CustomImage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customimage.html#cfn-sagemaker-userprofile-customimage-imageversionnumber // ImageVersionNumber *float64 `field:"optional" json:"imageVersionNumber" yaml:"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) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customImageProperty := &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }
type CfnUserProfile_CustomPosixUserConfigProperty ¶ added in v2.114.0
type CfnUserProfile_CustomPosixUserConfigProperty struct { // The POSIX group ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customposixuserconfig.html#cfn-sagemaker-userprofile-customposixuserconfig-gid // Gid *float64 `field:"required" json:"gid" yaml:"gid"` // The POSIX user ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-customposixuserconfig.html#cfn-sagemaker-userprofile-customposixuserconfig-uid // Uid *float64 `field:"required" json:"uid" yaml:"uid"` }
Details about the POSIX identity that is used for file system operations.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customPosixUserConfigProperty := &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }
type CfnUserProfile_DefaultEbsStorageSettingsProperty ¶ added in v2.114.0
type CfnUserProfile_DefaultEbsStorageSettingsProperty struct { // The default size of the EBS storage volume for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultebsstoragesettings.html#cfn-sagemaker-userprofile-defaultebsstoragesettings-defaultebsvolumesizeingb // DefaultEbsVolumeSizeInGb *float64 `field:"required" json:"defaultEbsVolumeSizeInGb" yaml:"defaultEbsVolumeSizeInGb"` // The maximum size of the EBS storage volume for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultebsstoragesettings.html#cfn-sagemaker-userprofile-defaultebsstoragesettings-maximumebsvolumesizeingb // MaximumEbsVolumeSizeInGb *float64 `field:"required" json:"maximumEbsVolumeSizeInGb" yaml:"maximumEbsVolumeSizeInGb"` }
A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultEbsStorageSettingsProperty := &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }
type CfnUserProfile_DefaultSpaceStorageSettingsProperty ¶ added in v2.114.0
type CfnUserProfile_DefaultSpaceStorageSettingsProperty struct { // The default EBS storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-defaultspacestoragesettings.html#cfn-sagemaker-userprofile-defaultspacestoragesettings-defaultebsstoragesettings // DefaultEbsStorageSettings interface{} `field:"optional" json:"defaultEbsStorageSettings" yaml:"defaultEbsStorageSettings"` }
The default storage settings for a space.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultSpaceStorageSettingsProperty := &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }
type CfnUserProfile_EFSFileSystemConfigProperty ¶ added in v2.114.0
type CfnUserProfile_EFSFileSystemConfigProperty struct { // The ID of your Amazon EFS file system. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-efsfilesystemconfig.html#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystemid // FileSystemId *string `field:"required" json:"fileSystemId" yaml:"fileSystemId"` // The path to the file system directory that is accessible in Amazon SageMaker Studio. // // Permitted users can access only this directory and below. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-efsfilesystemconfig.html#cfn-sagemaker-userprofile-efsfilesystemconfig-filesystempath // FileSystemPath *string `field:"optional" json:"fileSystemPath" yaml:"fileSystemPath"` }
The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker Domain.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eFSFileSystemConfigProperty := &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }
type CfnUserProfile_JupyterLabAppSettingsProperty ¶ added in v2.114.0
type CfnUserProfile_JupyterLabAppSettingsProperty struct { // A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-coderepositories // CodeRepositories interface{} `field:"optional" json:"codeRepositories" yaml:"codeRepositories"` // A list of custom SageMaker images that are configured to run as a JupyterLab app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. // // To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterlabappsettings.html#cfn-sagemaker-userprofile-jupyterlabappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The settings for the JupyterLab application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jupyterLabAppSettingsProperty := &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterserverappsettings.html#cfn-sagemaker-userprofile-jupyterserverappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. // // If you use this parameter, the `DefaultResourceSpec` parameter is also required. // // > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-jupyterserverappsettings.html#cfn-sagemaker-userprofile-jupyterserverappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The JupyterServer app settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jupyterServerAppSettingsProperty := &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnUserProfile_KernelGatewayAppSettingsProperty ¶
type CfnUserProfile_KernelGatewayAppSettingsProperty struct { // A list of custom SageMaker images that are configured to run as a KernelGateway app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html#cfn-sagemaker-userprofile-kernelgatewayappsettings-customimages // CustomImages interface{} `field:"optional" json:"customImages" yaml:"customImages"` // The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. // // > The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or AWS CloudFormation and the instance type parameter value is not passed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html#cfn-sagemaker-userprofile-kernelgatewayappsettings-defaultresourcespec // DefaultResourceSpec interface{} `field:"optional" json:"defaultResourceSpec" yaml:"defaultResourceSpec"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain. // // > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-kernelgatewayappsettings.html#cfn-sagemaker-userprofile-kernelgatewayappsettings-lifecycleconfigarns // LifecycleConfigArns *[]*string `field:"optional" json:"lifecycleConfigArns" yaml:"lifecycleConfigArns"` }
The KernelGateway app settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kernelGatewayAppSettingsProperty := &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }
type CfnUserProfile_RStudioServerProAppSettingsProperty ¶ added in v2.20.0
type CfnUserProfile_RStudioServerProAppSettingsProperty struct { // Indicates whether the current user has access to the `RStudioServerPro` app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-rstudioserverproappsettings.html#cfn-sagemaker-userprofile-rstudioserverproappsettings-accessstatus // AccessStatus *string `field:"optional" json:"accessStatus" yaml:"accessStatus"` // The level of permissions that the user has within the `RStudioServerPro` app. // // This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-rstudioserverproappsettings.html#cfn-sagemaker-userprofile-rstudioserverproappsettings-usergroup // UserGroup *string `field:"optional" json:"userGroup" yaml:"userGroup"` }
A collection of settings that configure user interaction with the `RStudioServerPro` app.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rStudioServerProAppSettingsProperty := &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }
type CfnUserProfile_ResourceSpecProperty ¶
type CfnUserProfile_ResourceSpecProperty struct { // The instance type that the image version runs on. // // > *JupyterServer apps* only support the `system` value. // > // > For *KernelGateway apps* , the `system` value is translated to `ml.t3.medium` . KernelGateway apps also support all other values for available instance types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-instancetype // InstanceType *string `field:"optional" json:"instanceType" yaml:"instanceType"` // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-lifecycleconfigarn // LifecycleConfigArn *string `field:"optional" json:"lifecycleConfigArn" yaml:"lifecycleConfigArn"` // The ARN of the SageMaker image that the image version belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-sagemakerimagearn // SageMakerImageArn *string `field:"optional" json:"sageMakerImageArn" yaml:"sageMakerImageArn"` // The ARN of the image version created on the instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-resourcespec.html#cfn-sagemaker-userprofile-resourcespec-sagemakerimageversionarn // SageMakerImageVersionArn *string `field:"optional" json:"sageMakerImageVersionArn" yaml:"sageMakerImageVersionArn"` }
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" resourceSpecProperty := &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }
type CfnUserProfile_SharingSettingsProperty ¶
type CfnUserProfile_SharingSettingsProperty struct { // Whether to include the notebook cell output when sharing the notebook. // // The default is `Disabled` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-notebookoutputoption // NotebookOutputOption *string `field:"optional" json:"notebookOutputOption" yaml:"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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-s3kmskeyid // S3KmsKeyId *string `field:"optional" json:"s3KmsKeyId" yaml:"s3KmsKeyId"` // When `NotebookOutputOption` is `Allowed` , the Amazon S3 bucket used to store the shared notebook snapshots. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-s3outputpath // S3OutputPath *string `field:"optional" json:"s3OutputPath" yaml:"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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sharingSettingsProperty := &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }
type CfnUserProfile_StudioWebPortalSettingsProperty ¶ added in v2.154.0
type CfnUserProfile_StudioWebPortalSettingsProperty struct { // The [Applications supported in Studio](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html) that are hidden from the Studio left navigation pane. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenapptypes // HiddenAppTypes *[]*string `field:"optional" json:"hiddenAppTypes" yaml:"hiddenAppTypes"` // The machine learning tools that are hidden from the Studio left navigation pane. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-studiowebportalsettings.html#cfn-sagemaker-userprofile-studiowebportalsettings-hiddenmltools // HiddenMlTools *[]*string `field:"optional" json:"hiddenMlTools" yaml:"hiddenMlTools"` }
Studio settings.
If these settings are applied on a user level, they take priority over the settings applied on a domain level.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" studioWebPortalSettingsProperty := &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }
type CfnUserProfile_UserSettingsProperty ¶
type CfnUserProfile_UserSettingsProperty struct { // The Code Editor application settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-codeeditorappsettings // CodeEditorAppSettings interface{} `field:"optional" json:"codeEditorAppSettings" yaml:"codeEditorAppSettings"` // The settings for assigning a custom file system to a user profile. // // Permitted users can access this file system in Amazon SageMaker Studio. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-customfilesystemconfigs // CustomFileSystemConfigs interface{} `field:"optional" json:"customFileSystemConfigs" yaml:"customFileSystemConfigs"` // Details about the POSIX identity that is used for file system operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-customposixuserconfig // CustomPosixUserConfig interface{} `field:"optional" json:"customPosixUserConfig" yaml:"customPosixUserConfig"` // The default experience that the user is directed to when accessing the domain. The supported values are:. // // - `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` . // - `app:JupyterServer:` : Indicates that Studio Classic is the default experience. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-defaultlandinguri // DefaultLandingUri *string `field:"optional" json:"defaultLandingUri" yaml:"defaultLandingUri"` // The execution role for the user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-executionrole // ExecutionRole *string `field:"optional" json:"executionRole" yaml:"executionRole"` // The settings for the JupyterLab application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-jupyterlabappsettings // JupyterLabAppSettings interface{} `field:"optional" json:"jupyterLabAppSettings" yaml:"jupyterLabAppSettings"` // The Jupyter server's app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-jupyterserverappsettings // JupyterServerAppSettings interface{} `field:"optional" json:"jupyterServerAppSettings" yaml:"jupyterServerAppSettings"` // The kernel gateway app settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-kernelgatewayappsettings // KernelGatewayAppSettings interface{} `field:"optional" json:"kernelGatewayAppSettings" yaml:"kernelGatewayAppSettings"` // A collection of settings that configure user interaction with the `RStudioServerPro` app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-rstudioserverproappsettings // RStudioServerProAppSettings interface{} `field:"optional" json:"rStudioServerProAppSettings" yaml:"rStudioServerProAppSettings"` // The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. // // Optional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` . // // Required when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` , unless specified as part of the `DefaultUserSettings` for the domain. // // Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-securitygroups // SecurityGroups *[]*string `field:"optional" json:"securityGroups" yaml:"securityGroups"` // Specifies options for sharing Amazon SageMaker Studio notebooks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-sharingsettings // SharingSettings interface{} `field:"optional" json:"sharingSettings" yaml:"sharingSettings"` // The storage settings for a space. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-spacestoragesettings // SpaceStorageSettings interface{} `field:"optional" json:"spaceStorageSettings" yaml:"spaceStorageSettings"` // Whether the user can access Studio. // // If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-studiowebportal // StudioWebPortal *string `field:"optional" json:"studioWebPortal" yaml:"studioWebPortal"` // Studio settings. // // If these settings are applied on a user level, they take priority over the settings applied on a domain level. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-studiowebportalsettings // StudioWebPortalSettings interface{} `field:"optional" json:"studioWebPortalSettings" yaml:"studioWebPortalSettings"` }
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` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" userSettingsProperty := &UserSettingsProperty{ CodeEditorAppSettings: &CodeEditorAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, CustomFileSystemConfigs: []interface{}{ &CustomFileSystemConfigProperty{ EfsFileSystemConfig: &EFSFileSystemConfigProperty{ FileSystemId: jsii.String("fileSystemId"), // the properties below are optional FileSystemPath: jsii.String("fileSystemPath"), }, }, }, CustomPosixUserConfig: &CustomPosixUserConfigProperty{ Gid: jsii.Number(123), Uid: jsii.Number(123), }, DefaultLandingUri: jsii.String("defaultLandingUri"), ExecutionRole: jsii.String("executionRole"), JupyterLabAppSettings: &JupyterLabAppSettingsProperty{ CodeRepositories: []interface{}{ &CodeRepositoryProperty{ RepositoryUrl: jsii.String("repositoryUrl"), }, }, CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, JupyterServerAppSettings: &JupyterServerAppSettingsProperty{ DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, KernelGatewayAppSettings: &KernelGatewayAppSettingsProperty{ CustomImages: []interface{}{ &CustomImageProperty{ AppImageConfigName: jsii.String("appImageConfigName"), ImageName: jsii.String("imageName"), // the properties below are optional ImageVersionNumber: jsii.Number(123), }, }, DefaultResourceSpec: &ResourceSpecProperty{ InstanceType: jsii.String("instanceType"), LifecycleConfigArn: jsii.String("lifecycleConfigArn"), SageMakerImageArn: jsii.String("sageMakerImageArn"), SageMakerImageVersionArn: jsii.String("sageMakerImageVersionArn"), }, LifecycleConfigArns: []*string{ jsii.String("lifecycleConfigArns"), }, }, RStudioServerProAppSettings: &RStudioServerProAppSettingsProperty{ AccessStatus: jsii.String("accessStatus"), UserGroup: jsii.String("userGroup"), }, SecurityGroups: []*string{ jsii.String("securityGroups"), }, SharingSettings: &SharingSettingsProperty{ NotebookOutputOption: jsii.String("notebookOutputOption"), S3KmsKeyId: jsii.String("s3KmsKeyId"), S3OutputPath: jsii.String("s3OutputPath"), }, SpaceStorageSettings: &DefaultSpaceStorageSettingsProperty{ DefaultEbsStorageSettings: &DefaultEbsStorageSettingsProperty{ DefaultEbsVolumeSizeInGb: jsii.Number(123), MaximumEbsVolumeSizeInGb: jsii.Number(123), }, }, StudioWebPortal: jsii.String("studioWebPortal"), StudioWebPortalSettings: &StudioWebPortalSettingsProperty{ HiddenAppTypes: []*string{ jsii.String("hiddenAppTypes"), }, HiddenMlTools: []*string{ jsii.String("hiddenMlTools"), }, }, }
type CfnWorkteam ¶
type CfnWorkteam interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // The name of the work team. AttrWorkteamName() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the work team. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A list of `MemberDefinition` objects that contains objects that identify the workers that make up the work team. MemberDefinitions() interface{} SetMemberDefinitions(val interface{}) // The tree node. Node() constructs.Node // Configures SNS notifications of available or expiring work items for work teams. NotificationConfiguration() interface{} SetNotificationConfiguration(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The name of the workforce. WorkforceName() *string SetWorkforceName(val *string) // The name of the work team. WorkteamName() *string SetWorkteamName(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWorkteam := awscdk.Aws_sagemaker.NewCfnWorkteam(this, jsii.String("MyCfnWorkteam"), &CfnWorkteamProps{ Description: jsii.String("description"), MemberDefinitions: []interface{}{ &MemberDefinitionProperty{ CognitoMemberDefinition: &CognitoMemberDefinitionProperty{ CognitoClientId: jsii.String("cognitoClientId"), CognitoUserGroup: jsii.String("cognitoUserGroup"), CognitoUserPool: jsii.String("cognitoUserPool"), }, OidcMemberDefinition: &OidcMemberDefinitionProperty{ OidcGroups: []*string{ jsii.String("oidcGroups"), }, }, }, }, NotificationConfiguration: &NotificationConfigurationProperty{ NotificationTopicArn: jsii.String("notificationTopicArn"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, WorkforceName: jsii.String("workforceName"), WorkteamName: jsii.String("workteamName"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html
func NewCfnWorkteam ¶
func NewCfnWorkteam(scope constructs.Construct, id *string, props *CfnWorkteamProps) CfnWorkteam
type CfnWorkteamProps ¶
type CfnWorkteamProps struct { // A description of the work team. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-description // Description *string `field:"optional" json:"description" yaml:"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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-memberdefinitions // MemberDefinitions interface{} `field:"optional" json:"memberDefinitions" yaml:"memberDefinitions"` // Configures SNS notifications of available or expiring work items for work teams. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-notificationconfiguration // NotificationConfiguration interface{} `field:"optional" json:"notificationConfiguration" yaml:"notificationConfiguration"` // An array of key-value pairs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The name of the workforce. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-workforcename // WorkforceName *string `field:"optional" json:"workforceName" yaml:"workforceName"` // The name of the work team. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-workteamname // WorkteamName *string `field:"optional" json:"workteamName" yaml:"workteamName"` }
Properties for defining a `CfnWorkteam`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnWorkteamProps := &CfnWorkteamProps{ Description: jsii.String("description"), MemberDefinitions: []interface{}{ &MemberDefinitionProperty{ CognitoMemberDefinition: &CognitoMemberDefinitionProperty{ CognitoClientId: jsii.String("cognitoClientId"), CognitoUserGroup: jsii.String("cognitoUserGroup"), CognitoUserPool: jsii.String("cognitoUserPool"), }, OidcMemberDefinition: &OidcMemberDefinitionProperty{ OidcGroups: []*string{ jsii.String("oidcGroups"), }, }, }, }, NotificationConfiguration: &NotificationConfigurationProperty{ NotificationTopicArn: jsii.String("notificationTopicArn"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, WorkforceName: jsii.String("workforceName"), WorkteamName: jsii.String("workteamName"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html
type CfnWorkteam_CognitoMemberDefinitionProperty ¶
type CfnWorkteam_CognitoMemberDefinitionProperty struct { // An identifier for an application client. // // You must create the app client ID using Amazon Cognito . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitoclientid // CognitoClientId *string `field:"required" json:"cognitoClientId" yaml:"cognitoClientId"` // An identifier for a user group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitousergroup // CognitoUserGroup *string `field:"required" json:"cognitoUserGroup" yaml:"cognitoUserGroup"` // An identifier for a user pool. // // The user pool must be in the same region as the service that you are calling. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitouserpool // CognitoUserPool *string `field:"required" json:"cognitoUserPool" yaml:"cognitoUserPool"` }
Identifies a Amazon Cognito user group.
A user group can be used in on or more work teams.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cognitoMemberDefinitionProperty := &CognitoMemberDefinitionProperty{ CognitoClientId: jsii.String("cognitoClientId"), CognitoUserGroup: jsii.String("cognitoUserGroup"), CognitoUserPool: jsii.String("cognitoUserPool"), }
type CfnWorkteam_MemberDefinitionProperty ¶
type CfnWorkteam_MemberDefinitionProperty struct { // The Amazon Cognito user group that is part of the work team. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-cognitomemberdefinition // CognitoMemberDefinition interface{} `field:"optional" json:"cognitoMemberDefinition" yaml:"cognitoMemberDefinition"` // A list user groups that exist in your OIDC Identity Provider (IdP). // // One to ten groups can be used to create a single private work team. When you add a user group to the list of `Groups` , you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-oidcmemberdefinition // OidcMemberDefinition interface{} `field:"optional" json:"oidcMemberDefinition" yaml:"oidcMemberDefinition"` }
Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" memberDefinitionProperty := &MemberDefinitionProperty{ CognitoMemberDefinition: &CognitoMemberDefinitionProperty{ CognitoClientId: jsii.String("cognitoClientId"), CognitoUserGroup: jsii.String("cognitoUserGroup"), CognitoUserPool: jsii.String("cognitoUserPool"), }, OidcMemberDefinition: &OidcMemberDefinitionProperty{ OidcGroups: []*string{ jsii.String("oidcGroups"), }, }, }
type CfnWorkteam_NotificationConfigurationProperty ¶
type CfnWorkteam_NotificationConfigurationProperty struct { // The ARN for the Amazon SNS topic to which notifications should be published. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-notificationconfiguration.html#cfn-sagemaker-workteam-notificationconfiguration-notificationtopicarn // NotificationTopicArn *string `field:"required" json:"notificationTopicArn" yaml:"notificationTopicArn"` }
Configures Amazon SNS notifications of available or expiring work items for work teams.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" notificationConfigurationProperty := &NotificationConfigurationProperty{ NotificationTopicArn: jsii.String("notificationTopicArn"), }
type CfnWorkteam_OidcMemberDefinitionProperty ¶ added in v2.45.0
type CfnWorkteam_OidcMemberDefinitionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-oidcmemberdefinition.html#cfn-sagemaker-workteam-oidcmemberdefinition-oidcgroups // OidcGroups *[]*string `field:"required" json:"oidcGroups" yaml:"oidcGroups"` }
A list of user groups that exist in your OIDC Identity Provider (IdP).
One to ten groups can be used to create a single private work team. When you add a user group to the list of `Groups` , you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" oidcMemberDefinitionProperty := &OidcMemberDefinitionProperty{ OidcGroups: []*string{ jsii.String("oidcGroups"), }, }
type IEndpoint ¶ added in v2.94.0
type IEndpoint interface { awscdk.IResource // Permits an IAM principal to invoke this endpoint. GrantInvoke(grantee awsiam.IGrantable) awsiam.Grant // The ARN of the endpoint. EndpointArn() *string // The name of the endpoint. EndpointName() *string }
The interface for a SageMaker Endpoint resource.
type IPipeline ¶ added in v2.128.0
type IPipeline interface { awscdk.IResource // Permits an IAM principal to start this pipeline execution. GrantStartPipelineExecution(grantee awsiam.IGrantable) awsiam.Grant // The ARN of the pipeline. PipelineArn() *string // The name of the pipeline. PipelineName() *string }
The interface for a SageMaker Pipeline resource.
Source Files ¶
- CfnApp.go
- CfnAppImageConfig.go
- CfnAppImageConfigProps.go
- CfnAppImageConfig_CodeEditorAppImageConfigProperty.go
- CfnAppImageConfig_ContainerConfigProperty.go
- CfnAppImageConfig_CustomImageContainerEnvironmentVariableProperty.go
- CfnAppImageConfig_FileSystemConfigProperty.go
- CfnAppImageConfig_JupyterLabAppImageConfigProperty.go
- CfnAppImageConfig_KernelGatewayImageConfigProperty.go
- CfnAppImageConfig_KernelSpecProperty.go
- CfnAppImageConfig__checks.go
- CfnAppProps.go
- CfnApp_ResourceSpecProperty.go
- CfnApp__checks.go
- CfnCluster.go
- CfnClusterProps.go
- CfnCluster_ClusterEbsVolumeConfigProperty.go
- CfnCluster_ClusterInstanceGroupProperty.go
- CfnCluster_ClusterInstanceStorageConfigProperty.go
- CfnCluster_ClusterLifeCycleConfigProperty.go
- CfnCluster_ClusterOrchestratorEksConfigProperty.go
- CfnCluster_OrchestratorProperty.go
- CfnCluster_VpcConfigProperty.go
- CfnCluster__checks.go
- CfnCodeRepository.go
- CfnCodeRepositoryProps.go
- CfnCodeRepository_GitConfigProperty.go
- CfnCodeRepository__checks.go
- CfnDataQualityJobDefinition.go
- CfnDataQualityJobDefinitionProps.go
- CfnDataQualityJobDefinition_BatchTransformInputProperty.go
- CfnDataQualityJobDefinition_ClusterConfigProperty.go
- CfnDataQualityJobDefinition_ConstraintsResourceProperty.go
- CfnDataQualityJobDefinition_CsvProperty.go
- CfnDataQualityJobDefinition_DataQualityAppSpecificationProperty.go
- CfnDataQualityJobDefinition_DataQualityBaselineConfigProperty.go
- CfnDataQualityJobDefinition_DataQualityJobInputProperty.go
- CfnDataQualityJobDefinition_DatasetFormatProperty.go
- CfnDataQualityJobDefinition_EndpointInputProperty.go
- CfnDataQualityJobDefinition_JsonProperty.go
- CfnDataQualityJobDefinition_MonitoringOutputConfigProperty.go
- CfnDataQualityJobDefinition_MonitoringOutputProperty.go
- CfnDataQualityJobDefinition_MonitoringResourcesProperty.go
- CfnDataQualityJobDefinition_NetworkConfigProperty.go
- CfnDataQualityJobDefinition_S3OutputProperty.go
- CfnDataQualityJobDefinition_StatisticsResourceProperty.go
- CfnDataQualityJobDefinition_StoppingConditionProperty.go
- CfnDataQualityJobDefinition_VpcConfigProperty.go
- CfnDataQualityJobDefinition__checks.go
- CfnDevice.go
- CfnDeviceFleet.go
- CfnDeviceFleetProps.go
- CfnDeviceFleet_EdgeOutputConfigProperty.go
- CfnDeviceFleet__checks.go
- CfnDeviceProps.go
- CfnDevice_DeviceProperty.go
- CfnDevice__checks.go
- CfnDomain.go
- CfnDomainProps.go
- CfnDomain_CodeEditorAppSettingsProperty.go
- CfnDomain_CodeRepositoryProperty.go
- CfnDomain_CustomFileSystemConfigProperty.go
- CfnDomain_CustomImageProperty.go
- CfnDomain_CustomPosixUserConfigProperty.go
- CfnDomain_DefaultEbsStorageSettingsProperty.go
- CfnDomain_DefaultSpaceSettingsProperty.go
- CfnDomain_DefaultSpaceStorageSettingsProperty.go
- CfnDomain_DockerSettingsProperty.go
- CfnDomain_DomainSettingsProperty.go
- CfnDomain_EFSFileSystemConfigProperty.go
- CfnDomain_JupyterLabAppSettingsProperty.go
- CfnDomain_JupyterServerAppSettingsProperty.go
- CfnDomain_KernelGatewayAppSettingsProperty.go
- CfnDomain_RSessionAppSettingsProperty.go
- CfnDomain_RStudioServerProAppSettingsProperty.go
- CfnDomain_RStudioServerProDomainSettingsProperty.go
- CfnDomain_ResourceSpecProperty.go
- CfnDomain_SharingSettingsProperty.go
- CfnDomain_StudioWebPortalSettingsProperty.go
- CfnDomain_UserSettingsProperty.go
- CfnDomain__checks.go
- CfnEndpoint.go
- CfnEndpointConfig.go
- CfnEndpointConfigProps.go
- CfnEndpointConfig_AsyncInferenceClientConfigProperty.go
- CfnEndpointConfig_AsyncInferenceConfigProperty.go
- CfnEndpointConfig_AsyncInferenceNotificationConfigProperty.go
- CfnEndpointConfig_AsyncInferenceOutputConfigProperty.go
- CfnEndpointConfig_CaptureContentTypeHeaderProperty.go
- CfnEndpointConfig_CaptureOptionProperty.go
- CfnEndpointConfig_ClarifyExplainerConfigProperty.go
- CfnEndpointConfig_ClarifyInferenceConfigProperty.go
- CfnEndpointConfig_ClarifyShapBaselineConfigProperty.go
- CfnEndpointConfig_ClarifyShapConfigProperty.go
- CfnEndpointConfig_ClarifyTextConfigProperty.go
- CfnEndpointConfig_DataCaptureConfigProperty.go
- CfnEndpointConfig_ExplainerConfigProperty.go
- CfnEndpointConfig_ManagedInstanceScalingProperty.go
- CfnEndpointConfig_ProductionVariantProperty.go
- CfnEndpointConfig_RoutingConfigProperty.go
- CfnEndpointConfig_ServerlessConfigProperty.go
- CfnEndpointConfig_VpcConfigProperty.go
- CfnEndpointConfig__checks.go
- CfnEndpointProps.go
- CfnEndpoint_AlarmProperty.go
- CfnEndpoint_AutoRollbackConfigProperty.go
- CfnEndpoint_BlueGreenUpdatePolicyProperty.go
- CfnEndpoint_CapacitySizeProperty.go
- CfnEndpoint_DeploymentConfigProperty.go
- CfnEndpoint_RollingUpdatePolicyProperty.go
- CfnEndpoint_TrafficRoutingConfigProperty.go
- CfnEndpoint_VariantPropertyProperty.go
- CfnEndpoint__checks.go
- CfnFeatureGroup.go
- CfnFeatureGroupProps.go
- CfnFeatureGroup_DataCatalogConfigProperty.go
- CfnFeatureGroup_FeatureDefinitionProperty.go
- CfnFeatureGroup_OfflineStoreConfigProperty.go
- CfnFeatureGroup_OnlineStoreConfigProperty.go
- CfnFeatureGroup_OnlineStoreSecurityConfigProperty.go
- CfnFeatureGroup_S3StorageConfigProperty.go
- CfnFeatureGroup_ThroughputConfigProperty.go
- CfnFeatureGroup_TtlDurationProperty.go
- CfnFeatureGroup__checks.go
- CfnImage.go
- CfnImageProps.go
- CfnImageVersion.go
- CfnImageVersionProps.go
- CfnImageVersion__checks.go
- CfnImage__checks.go
- CfnInferenceComponent.go
- CfnInferenceComponentProps.go
- CfnInferenceComponent_DeployedImageProperty.go
- CfnInferenceComponent_InferenceComponentComputeResourceRequirementsProperty.go
- CfnInferenceComponent_InferenceComponentContainerSpecificationProperty.go
- CfnInferenceComponent_InferenceComponentRuntimeConfigProperty.go
- CfnInferenceComponent_InferenceComponentSpecificationProperty.go
- CfnInferenceComponent_InferenceComponentStartupParametersProperty.go
- CfnInferenceComponent__checks.go
- CfnInferenceExperiment.go
- CfnInferenceExperimentProps.go
- CfnInferenceExperiment_CaptureContentTypeHeaderProperty.go
- CfnInferenceExperiment_DataStorageConfigProperty.go
- CfnInferenceExperiment_EndpointMetadataProperty.go
- CfnInferenceExperiment_InferenceExperimentScheduleProperty.go
- CfnInferenceExperiment_ModelInfrastructureConfigProperty.go
- CfnInferenceExperiment_ModelVariantConfigProperty.go
- CfnInferenceExperiment_RealTimeInferenceConfigProperty.go
- CfnInferenceExperiment_ShadowModeConfigProperty.go
- CfnInferenceExperiment_ShadowModelVariantConfigProperty.go
- CfnInferenceExperiment__checks.go
- CfnMlflowTrackingServer.go
- CfnMlflowTrackingServerProps.go
- CfnMlflowTrackingServer__checks.go
- CfnModel.go
- CfnModelBiasJobDefinition.go
- CfnModelBiasJobDefinitionProps.go
- CfnModelBiasJobDefinition_BatchTransformInputProperty.go
- CfnModelBiasJobDefinition_ClusterConfigProperty.go
- CfnModelBiasJobDefinition_ConstraintsResourceProperty.go
- CfnModelBiasJobDefinition_CsvProperty.go
- CfnModelBiasJobDefinition_DatasetFormatProperty.go
- CfnModelBiasJobDefinition_EndpointInputProperty.go
- CfnModelBiasJobDefinition_JsonProperty.go
- CfnModelBiasJobDefinition_ModelBiasAppSpecificationProperty.go
- CfnModelBiasJobDefinition_ModelBiasBaselineConfigProperty.go
- CfnModelBiasJobDefinition_ModelBiasJobInputProperty.go
- CfnModelBiasJobDefinition_MonitoringGroundTruthS3InputProperty.go
- CfnModelBiasJobDefinition_MonitoringOutputConfigProperty.go
- CfnModelBiasJobDefinition_MonitoringOutputProperty.go
- CfnModelBiasJobDefinition_MonitoringResourcesProperty.go
- CfnModelBiasJobDefinition_NetworkConfigProperty.go
- CfnModelBiasJobDefinition_S3OutputProperty.go
- CfnModelBiasJobDefinition_StoppingConditionProperty.go
- CfnModelBiasJobDefinition_VpcConfigProperty.go
- CfnModelBiasJobDefinition__checks.go
- CfnModelCard.go
- CfnModelCardProps.go
- CfnModelCard_AdditionalInformationProperty.go
- CfnModelCard_BusinessDetailsProperty.go
- CfnModelCard_ContainerProperty.go
- CfnModelCard_ContentProperty.go
- CfnModelCard_EvaluationDetailProperty.go
- CfnModelCard_FunctionProperty.go
- CfnModelCard_InferenceEnvironmentProperty.go
- CfnModelCard_InferenceSpecificationProperty.go
- CfnModelCard_IntendedUsesProperty.go
- CfnModelCard_MetricDataItemsProperty.go
- CfnModelCard_MetricGroupProperty.go
- CfnModelCard_ModelOverviewProperty.go
- CfnModelCard_ModelPackageCreatorProperty.go
- CfnModelCard_ModelPackageDetailsProperty.go
- CfnModelCard_ObjectiveFunctionProperty.go
- CfnModelCard_SecurityConfigProperty.go
- CfnModelCard_SourceAlgorithmProperty.go
- CfnModelCard_TrainingDetailsProperty.go
- CfnModelCard_TrainingEnvironmentProperty.go
- CfnModelCard_TrainingHyperParameterProperty.go
- CfnModelCard_TrainingJobDetailsProperty.go
- CfnModelCard_TrainingMetricProperty.go
- CfnModelCard_UserContextProperty.go
- CfnModelCard__checks.go
- CfnModelExplainabilityJobDefinition.go
- CfnModelExplainabilityJobDefinitionProps.go
- CfnModelExplainabilityJobDefinition_BatchTransformInputProperty.go
- CfnModelExplainabilityJobDefinition_ClusterConfigProperty.go
- CfnModelExplainabilityJobDefinition_ConstraintsResourceProperty.go
- CfnModelExplainabilityJobDefinition_CsvProperty.go
- CfnModelExplainabilityJobDefinition_DatasetFormatProperty.go
- CfnModelExplainabilityJobDefinition_EndpointInputProperty.go
- CfnModelExplainabilityJobDefinition_JsonProperty.go
- CfnModelExplainabilityJobDefinition_ModelExplainabilityAppSpecificationProperty.go
- CfnModelExplainabilityJobDefinition_ModelExplainabilityBaselineConfigProperty.go
- CfnModelExplainabilityJobDefinition_ModelExplainabilityJobInputProperty.go
- CfnModelExplainabilityJobDefinition_MonitoringOutputConfigProperty.go
- CfnModelExplainabilityJobDefinition_MonitoringOutputProperty.go
- CfnModelExplainabilityJobDefinition_MonitoringResourcesProperty.go
- CfnModelExplainabilityJobDefinition_NetworkConfigProperty.go
- CfnModelExplainabilityJobDefinition_S3OutputProperty.go
- CfnModelExplainabilityJobDefinition_StoppingConditionProperty.go
- CfnModelExplainabilityJobDefinition_VpcConfigProperty.go
- CfnModelExplainabilityJobDefinition__checks.go
- CfnModelPackage.go
- CfnModelPackageGroup.go
- CfnModelPackageGroupProps.go
- CfnModelPackageGroup__checks.go
- CfnModelPackageProps.go
- CfnModelPackage_AdditionalInferenceSpecificationDefinitionProperty.go
- CfnModelPackage_BiasProperty.go
- CfnModelPackage_DataSourceProperty.go
- CfnModelPackage_DriftCheckBaselinesProperty.go
- CfnModelPackage_DriftCheckBiasProperty.go
- CfnModelPackage_DriftCheckExplainabilityProperty.go
- CfnModelPackage_DriftCheckModelDataQualityProperty.go
- CfnModelPackage_DriftCheckModelQualityProperty.go
- CfnModelPackage_ExplainabilityProperty.go
- CfnModelPackage_FileSourceProperty.go
- CfnModelPackage_InferenceSpecificationProperty.go
- CfnModelPackage_MetadataPropertiesProperty.go
- CfnModelPackage_MetricsSourceProperty.go
- CfnModelPackage_ModelAccessConfigProperty.go
- CfnModelPackage_ModelCardProperty.go
- CfnModelPackage_ModelDataQualityProperty.go
- CfnModelPackage_ModelDataSourceProperty.go
- CfnModelPackage_ModelInputProperty.go
- CfnModelPackage_ModelMetricsProperty.go
- CfnModelPackage_ModelPackageContainerDefinitionProperty.go
- CfnModelPackage_ModelPackageStatusDetailsProperty.go
- CfnModelPackage_ModelPackageStatusItemProperty.go
- CfnModelPackage_ModelQualityProperty.go
- CfnModelPackage_S3DataSourceProperty.go
- CfnModelPackage_S3ModelDataSourceProperty.go
- CfnModelPackage_SecurityConfigProperty.go
- CfnModelPackage_SourceAlgorithmProperty.go
- CfnModelPackage_SourceAlgorithmSpecificationProperty.go
- CfnModelPackage_TransformInputProperty.go
- CfnModelPackage_TransformJobDefinitionProperty.go
- CfnModelPackage_TransformOutputProperty.go
- CfnModelPackage_TransformResourcesProperty.go
- CfnModelPackage_ValidationProfileProperty.go
- CfnModelPackage_ValidationSpecificationProperty.go
- CfnModelPackage__checks.go
- CfnModelProps.go
- CfnModelQualityJobDefinition.go
- CfnModelQualityJobDefinitionProps.go
- CfnModelQualityJobDefinition_BatchTransformInputProperty.go
- CfnModelQualityJobDefinition_ClusterConfigProperty.go
- CfnModelQualityJobDefinition_ConstraintsResourceProperty.go
- CfnModelQualityJobDefinition_CsvProperty.go
- CfnModelQualityJobDefinition_DatasetFormatProperty.go
- CfnModelQualityJobDefinition_EndpointInputProperty.go
- CfnModelQualityJobDefinition_JsonProperty.go
- CfnModelQualityJobDefinition_ModelQualityAppSpecificationProperty.go
- CfnModelQualityJobDefinition_ModelQualityBaselineConfigProperty.go
- CfnModelQualityJobDefinition_ModelQualityJobInputProperty.go
- CfnModelQualityJobDefinition_MonitoringGroundTruthS3InputProperty.go
- CfnModelQualityJobDefinition_MonitoringOutputConfigProperty.go
- CfnModelQualityJobDefinition_MonitoringOutputProperty.go
- CfnModelQualityJobDefinition_MonitoringResourcesProperty.go
- CfnModelQualityJobDefinition_NetworkConfigProperty.go
- CfnModelQualityJobDefinition_S3OutputProperty.go
- CfnModelQualityJobDefinition_StoppingConditionProperty.go
- CfnModelQualityJobDefinition_VpcConfigProperty.go
- CfnModelQualityJobDefinition__checks.go
- CfnModel_ContainerDefinitionProperty.go
- CfnModel_HubAccessConfigProperty.go
- CfnModel_ImageConfigProperty.go
- CfnModel_InferenceExecutionConfigProperty.go
- CfnModel_ModelAccessConfigProperty.go
- CfnModel_ModelDataSourceProperty.go
- CfnModel_MultiModelConfigProperty.go
- CfnModel_RepositoryAuthConfigProperty.go
- CfnModel_S3DataSourceProperty.go
- CfnModel_VpcConfigProperty.go
- CfnModel__checks.go
- CfnMonitoringSchedule.go
- CfnMonitoringScheduleProps.go
- CfnMonitoringSchedule_BaselineConfigProperty.go
- CfnMonitoringSchedule_BatchTransformInputProperty.go
- CfnMonitoringSchedule_ClusterConfigProperty.go
- CfnMonitoringSchedule_ConstraintsResourceProperty.go
- CfnMonitoringSchedule_CsvProperty.go
- CfnMonitoringSchedule_DatasetFormatProperty.go
- CfnMonitoringSchedule_EndpointInputProperty.go
- CfnMonitoringSchedule_JsonProperty.go
- CfnMonitoringSchedule_MonitoringAppSpecificationProperty.go
- CfnMonitoringSchedule_MonitoringExecutionSummaryProperty.go
- CfnMonitoringSchedule_MonitoringInputProperty.go
- CfnMonitoringSchedule_MonitoringJobDefinitionProperty.go
- CfnMonitoringSchedule_MonitoringOutputConfigProperty.go
- CfnMonitoringSchedule_MonitoringOutputProperty.go
- CfnMonitoringSchedule_MonitoringResourcesProperty.go
- CfnMonitoringSchedule_MonitoringScheduleConfigProperty.go
- CfnMonitoringSchedule_NetworkConfigProperty.go
- CfnMonitoringSchedule_S3OutputProperty.go
- CfnMonitoringSchedule_ScheduleConfigProperty.go
- CfnMonitoringSchedule_StatisticsResourceProperty.go
- CfnMonitoringSchedule_StoppingConditionProperty.go
- CfnMonitoringSchedule_VpcConfigProperty.go
- CfnMonitoringSchedule__checks.go
- CfnNotebookInstance.go
- CfnNotebookInstanceLifecycleConfig.go
- CfnNotebookInstanceLifecycleConfigProps.go
- CfnNotebookInstanceLifecycleConfig_NotebookInstanceLifecycleHookProperty.go
- CfnNotebookInstanceLifecycleConfig__checks.go
- CfnNotebookInstanceProps.go
- CfnNotebookInstance_InstanceMetadataServiceConfigurationProperty.go
- CfnNotebookInstance__checks.go
- CfnPipeline.go
- CfnPipelineProps.go
- CfnPipeline_ParallelismConfigurationProperty.go
- CfnPipeline_PipelineDefinitionProperty.go
- CfnPipeline_S3LocationProperty.go
- CfnPipeline__checks.go
- CfnProject.go
- CfnProjectProps.go
- CfnProject_ProvisioningParameterProperty.go
- CfnProject_ServiceCatalogProvisionedProductDetailsProperty.go
- CfnProject_ServiceCatalogProvisioningDetailsProperty.go
- CfnProject__checks.go
- CfnSpace.go
- CfnSpaceProps.go
- CfnSpace_CodeRepositoryProperty.go
- CfnSpace_CustomFileSystemProperty.go
- CfnSpace_CustomImageProperty.go
- CfnSpace_EFSFileSystemProperty.go
- CfnSpace_EbsStorageSettingsProperty.go
- CfnSpace_JupyterServerAppSettingsProperty.go
- CfnSpace_KernelGatewayAppSettingsProperty.go
- CfnSpace_OwnershipSettingsProperty.go
- CfnSpace_ResourceSpecProperty.go
- CfnSpace_SpaceCodeEditorAppSettingsProperty.go
- CfnSpace_SpaceJupyterLabAppSettingsProperty.go
- CfnSpace_SpaceSettingsProperty.go
- CfnSpace_SpaceSharingSettingsProperty.go
- CfnSpace_SpaceStorageSettingsProperty.go
- CfnSpace__checks.go
- CfnStudioLifecycleConfig.go
- CfnStudioLifecycleConfigProps.go
- CfnStudioLifecycleConfig__checks.go
- CfnUserProfile.go
- CfnUserProfileProps.go
- CfnUserProfile_CodeEditorAppSettingsProperty.go
- CfnUserProfile_CodeRepositoryProperty.go
- CfnUserProfile_CustomFileSystemConfigProperty.go
- CfnUserProfile_CustomImageProperty.go
- CfnUserProfile_CustomPosixUserConfigProperty.go
- CfnUserProfile_DefaultEbsStorageSettingsProperty.go
- CfnUserProfile_DefaultSpaceStorageSettingsProperty.go
- CfnUserProfile_EFSFileSystemConfigProperty.go
- CfnUserProfile_JupyterLabAppSettingsProperty.go
- CfnUserProfile_JupyterServerAppSettingsProperty.go
- CfnUserProfile_KernelGatewayAppSettingsProperty.go
- CfnUserProfile_RStudioServerProAppSettingsProperty.go
- CfnUserProfile_ResourceSpecProperty.go
- CfnUserProfile_SharingSettingsProperty.go
- CfnUserProfile_StudioWebPortalSettingsProperty.go
- CfnUserProfile_UserSettingsProperty.go
- CfnUserProfile__checks.go
- CfnWorkteam.go
- CfnWorkteamProps.go
- CfnWorkteam_CognitoMemberDefinitionProperty.go
- CfnWorkteam_MemberDefinitionProperty.go
- CfnWorkteam_NotificationConfigurationProperty.go
- CfnWorkteam_OidcMemberDefinitionProperty.go
- CfnWorkteam__checks.go
- IEndpoint.go
- IEndpoint__checks.go
- IPipeline.go
- IPipeline__checks.go
- main.go