UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,084 lines 991 kB
import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { AppImageConfigReference, AppReference, ClusterReference, CodeRepositoryReference, DataQualityJobDefinitionReference, DeviceFleetReference, DeviceReference, DomainReference, EndpointConfigReference, EndpointReference, FeatureGroupReference, IAppImageConfigRef, IAppRef, IClusterRef, ICodeRepositoryRef, IDataQualityJobDefinitionRef, IDeviceFleetRef, IDeviceRef, IDomainRef, IEndpointConfigRef, IEndpointRef, IFeatureGroupRef, IImageRef, IImageVersionRef, IInferenceComponentRef, IInferenceExperimentRef, ImageReference, ImageVersionReference, IMlflowTrackingServerRef, IModelBiasJobDefinitionRef, IModelCardRef, IModelExplainabilityJobDefinitionRef, IModelPackageGroupRef, IModelPackageRef, IModelQualityJobDefinitionRef, IModelRef, IMonitoringScheduleRef, InferenceComponentReference, InferenceExperimentReference, INotebookInstanceLifecycleConfigRef, INotebookInstanceRef, IPartnerAppRef, IPipelineRef, IProcessingJobRef, IProjectRef, ISpaceRef, IStudioLifecycleConfigRef, IUserProfileRef, IWorkteamRef, MlflowTrackingServerReference, ModelBiasJobDefinitionReference, ModelCardReference, ModelExplainabilityJobDefinitionReference, ModelPackageGroupReference, ModelPackageReference, ModelQualityJobDefinitionReference, ModelReference, MonitoringScheduleReference, NotebookInstanceLifecycleConfigReference, NotebookInstanceReference, PartnerAppReference, PipelineReference, ProcessingJobReference, ProjectReference, SpaceReference, StudioLifecycleConfigReference, UserProfileReference, WorkteamReference } from "../../interfaces/generated/aws-sagemaker-interfaces.generated"; import { aws_ec2 as ec2Refs, aws_iam as iamRefs, aws_sagemaker as sageMakerRefs } from "../../interfaces"; /** * Creates a running app for the specified UserProfile. * * This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. * * @cloudformationResource AWS::SageMaker::App * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html */ export declare class CfnApp extends cdk.CfnResource implements cdk.IInspectable, IAppRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnApp from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApp; /** * Checks whether the given object is a CfnApp */ static isCfnApp(x: any): x is CfnApp; static arnForApp(resource: IAppRef): string; /** * The name of the app. */ private _appName; /** * The type of app. */ private _appType; /** * The domain ID. */ private _domainId; /** * Indicates whether the application is launched in recovery mode. */ private _recoveryMode?; /** * Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. */ private _resourceSpec?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * An array of key-value pairs to apply to this resource. */ private _tagsRaw?; /** * The user profile name. */ private _userProfileName; /** * Create a new `AWS::SageMaker::App`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAppProps); get appRef(): AppReference; /** * The name of the app. */ get appName(): string; /** * The name of the app. */ set appName(value: string); /** * The type of app. */ get appType(): string; /** * The type of app. */ set appType(value: string); /** * The domain ID. */ get domainId(): string; /** * The domain ID. */ set domainId(value: string); /** * Indicates whether the application is launched in recovery mode. */ get recoveryMode(): boolean | cdk.IResolvable | undefined; /** * Indicates whether the application is launched in recovery mode. */ set recoveryMode(value: boolean | cdk.IResolvable | undefined); /** * Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. */ get resourceSpec(): cdk.IResolvable | CfnApp.ResourceSpecProperty | undefined; /** * Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. */ set resourceSpec(value: cdk.IResolvable | CfnApp.ResourceSpecProperty | undefined); /** * An array of key-value pairs to apply to this resource. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * An array of key-value pairs to apply to this resource. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The user profile name. */ get userProfileName(): string; /** * The user profile name. */ set userProfileName(value: string); /** * The Amazon Resource Name (ARN) of the app, such as `arn:aws:sagemaker:us-west-2:account-id:app/my-app-name` . * * @cloudformationAttribute AppArn */ get attrAppArn(): string; /** * The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration. * * @cloudformationAttribute BuiltInLifecycleConfigArn */ get attrBuiltInLifecycleConfigArn(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnApp { /** * Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on. * * > When both `SageMakerImageVersionArn` and `SageMakerImageArn` are passed, `SageMakerImageVersionArn` is used. Any updates to `SageMakerImageArn` will not take effect if `SageMakerImageVersionArn` already exists in the `ResourceSpec` because `SageMakerImageVersionArn` always takes precedence. To clear the value set for `SageMakerImageVersionArn` , pass `None` as the value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html */ interface ResourceSpecProperty { /** * 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 */ readonly instanceType?: string; /** * 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 */ readonly lifecycleConfigArn?: string; /** * The ARN of the SageMaker AI 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 */ readonly sageMakerImageArn?: string; /** * The ARN of the image version created on the instance. * * To clear the value set for `SageMakerImageVersionArn` , pass `None` as the value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimageversionarn */ readonly sageMakerImageVersionArn?: string; } } /** * Properties for defining a `CfnApp` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html */ export interface CfnAppProps { /** * The name of the app. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-appname */ readonly appName: string; /** * The type of app. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-apptype */ readonly appType: string; /** * The domain ID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-domainid */ readonly domainId: string; /** * Indicates whether the application is launched in recovery mode. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-recoverymode */ readonly recoveryMode?: boolean | cdk.IResolvable; /** * 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 */ readonly resourceSpec?: cdk.IResolvable | CfnApp.ResourceSpecProperty; /** * 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 */ readonly tags?: Array<cdk.CfnTag>; /** * The user profile name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-userprofilename */ readonly userProfileName: string; } /** * Creates a configuration for running a SageMaker AI 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. * * @cloudformationResource AWS::SageMaker::AppImageConfig * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html */ export declare class CfnAppImageConfig extends cdk.CfnResource implements cdk.IInspectable, IAppImageConfigRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAppImageConfig from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAppImageConfig; /** * Checks whether the given object is a CfnAppImageConfig */ static isCfnAppImageConfig(x: any): x is CfnAppImageConfig; /** * Creates a new IAppImageConfigRef from an ARN */ static fromAppImageConfigArn(scope: constructs.Construct, id: string, arn: string): IAppImageConfigRef; /** * Creates a new IAppImageConfigRef from a appImageConfigName */ static fromAppImageConfigName(scope: constructs.Construct, id: string, appImageConfigName: string): IAppImageConfigRef; static arnForAppImageConfig(resource: IAppImageConfigRef): string; /** * The name of the AppImageConfig. */ private _appImageConfigName; /** * The configuration for the file system and the runtime, such as the environment variables and entry point. */ private _codeEditorAppImageConfig?; /** * The configuration for the file system and the runtime, such as the environment variables and entry point. */ private _jupyterLabAppImageConfig?; /** * The configuration for the file system and kernels in the SageMaker AI image. */ private _kernelGatewayImageConfig?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * An array of key-value pairs to apply to this resource. */ private _tagsRaw?; /** * Create a new `AWS::SageMaker::AppImageConfig`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAppImageConfigProps); get appImageConfigRef(): AppImageConfigReference; /** * The name of the AppImageConfig. */ get appImageConfigName(): string; /** * The name of the AppImageConfig. */ set appImageConfigName(value: string); /** * The configuration for the file system and the runtime, such as the environment variables and entry point. */ get codeEditorAppImageConfig(): CfnAppImageConfig.CodeEditorAppImageConfigProperty | cdk.IResolvable | undefined; /** * The configuration for the file system and the runtime, such as the environment variables and entry point. */ set codeEditorAppImageConfig(value: CfnAppImageConfig.CodeEditorAppImageConfigProperty | cdk.IResolvable | undefined); /** * The configuration for the file system and the runtime, such as the environment variables and entry point. */ get jupyterLabAppImageConfig(): cdk.IResolvable | CfnAppImageConfig.JupyterLabAppImageConfigProperty | undefined; /** * The configuration for the file system and the runtime, such as the environment variables and entry point. */ set jupyterLabAppImageConfig(value: cdk.IResolvable | CfnAppImageConfig.JupyterLabAppImageConfigProperty | undefined); /** * The configuration for the file system and kernels in the SageMaker AI image. */ get kernelGatewayImageConfig(): cdk.IResolvable | CfnAppImageConfig.KernelGatewayImageConfigProperty | undefined; /** * The configuration for the file system and kernels in the SageMaker AI image. */ set kernelGatewayImageConfig(value: cdk.IResolvable | CfnAppImageConfig.KernelGatewayImageConfigProperty | undefined); /** * An array of key-value pairs to apply to this resource. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * An array of key-value pairs to apply to this resource. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * 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` . * * @cloudformationAttribute AppImageConfigArn */ get attrAppImageConfigArn(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnAppImageConfig { /** * The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html */ interface KernelGatewayImageConfigProperty { /** * The Amazon Elastic File System storage configuration for a SageMaker AI image. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-filesystemconfig */ readonly fileSystemConfig?: CfnAppImageConfig.FileSystemConfigProperty | cdk.IResolvable; /** * 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 */ readonly kernelSpecs: Array<cdk.IResolvable | CfnAppImageConfig.KernelSpecProperty> | cdk.IResolvable; } /** * The specification of a Jupyter kernel. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html */ interface KernelSpecProperty { /** * 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 */ readonly displayName?: string; /** * 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 */ readonly name: string; } /** * The Amazon Elastic File System storage configuration for a SageMaker AI image. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html */ interface FileSystemConfigProperty { /** * 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 */ readonly defaultGid?: number; /** * 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 */ readonly defaultUid?: number; /** * 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 */ readonly mountPath?: string; } /** * The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app. * * The `FileSystemConfig` object is not supported. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html */ interface JupyterLabAppImageConfigProperty { /** * 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 */ readonly containerConfig?: CfnAppImageConfig.ContainerConfigProperty | cdk.IResolvable; } /** * The configuration used to run the application image container. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html */ interface ContainerConfigProperty { /** * 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 */ readonly containerArguments?: Array<string>; /** * 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 */ readonly containerEntrypoint?: Array<string>; /** * 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 */ readonly containerEnvironmentVariables?: Array<CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty | cdk.IResolvable> | cdk.IResolvable; } /** * The environment variables to set in the container. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html */ interface CustomImageContainerEnvironmentVariableProperty { /** * 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 */ readonly key: string; /** * 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 */ readonly value: string; } /** * The configuration for the file system and kernels in a SageMaker image running as a Code Editor app. * * The `FileSystemConfig` object is not supported. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-codeeditorappimageconfig.html */ interface CodeEditorAppImageConfigProperty { /** * 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 */ readonly containerConfig?: CfnAppImageConfig.ContainerConfigProperty | cdk.IResolvable; } } /** * Properties for defining a `CfnAppImageConfig` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html */ export interface CfnAppImageConfigProps { /** * 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 */ readonly appImageConfigName: string; /** * 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 */ readonly codeEditorAppImageConfig?: CfnAppImageConfig.CodeEditorAppImageConfigProperty | cdk.IResolvable; /** * 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 */ readonly jupyterLabAppImageConfig?: cdk.IResolvable | CfnAppImageConfig.JupyterLabAppImageConfigProperty; /** * The configuration for the file system and kernels in the SageMaker AI image. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig */ readonly kernelGatewayImageConfig?: cdk.IResolvable | CfnAppImageConfig.KernelGatewayImageConfigProperty; /** * 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 */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a Git repository as a resource in your SageMaker AI 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 AI 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. * * @cloudformationResource AWS::SageMaker::CodeRepository * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html */ export declare class CfnCodeRepository extends cdk.CfnResource implements cdk.IInspectable, ICodeRepositoryRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnCodeRepository from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCodeRepository; /** * Checks whether the given object is a CfnCodeRepository */ static isCfnCodeRepository(x: any): x is CfnCodeRepository; static arnForCodeRepository(resource: ICodeRepositoryRef): string; /** * The name of the Git repository. */ private _codeRepositoryName?; /** * 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. */ private _gitConfig; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * List of tags for Code Repository. */ private _tagsRaw?; /** * Create a new `AWS::SageMaker::CodeRepository`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnCodeRepositoryProps); get codeRepositoryRef(): CodeRepositoryReference; /** * The name of the Git repository. */ get codeRepositoryName(): string | undefined; /** * The name of the Git repository. */ set codeRepositoryName(value: string | undefined); /** * 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. */ get gitConfig(): CfnCodeRepository.GitConfigProperty | cdk.IResolvable; /** * 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. */ set gitConfig(value: CfnCodeRepository.GitConfigProperty | cdk.IResolvable); /** * List of tags for Code Repository. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * List of tags for Code Repository. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The name of the code repository, such as `myCodeRepo` . * * @cloudformationAttribute CodeRepositoryName */ get attrCodeRepositoryName(): string; /** * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnCodeRepository { /** * Specifies configuration details for a Git repository in your AWS account. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-coderepository-gitconfig.html */ interface GitConfigProperty { /** * 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 */ readonly branch?: string; /** * 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 */ readonly repositoryUrl: string; /** * 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 */ readonly secretArn?: string; } } /** * Properties for defining a `CfnCodeRepository` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html */ export interface CfnCodeRepositoryProps { /** * The name of the Git repository. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-coderepositoryname */ readonly codeRepositoryName?: 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-gitconfig */ readonly gitConfig: CfnCodeRepository.GitConfigProperty | cdk.IResolvable; /** * List of tags for Code Repository. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-coderepository.html#cfn-sagemaker-coderepository-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a definition for a job that monitors data quality and drift. * * For information about model monitor, see [Amazon SageMaker AI Model Monitor](https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) . * * @cloudformationResource AWS::SageMaker::DataQualityJobDefinition * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html */ export declare class CfnDataQualityJobDefinition extends cdk.CfnResource implements cdk.IInspectable, IDataQualityJobDefinitionRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDataQualityJobDefinition from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDataQualityJobDefinition; /** * Checks whether the given object is a CfnDataQualityJobDefinition */ static isCfnDataQualityJobDefinition(x: any): x is CfnDataQualityJobDefinition; /** * Specifies the container that runs the monitoring job. */ private _dataQualityAppSpecification; /** * Configures the constraints and baselines for the monitoring job. */ private _dataQualityBaselineConfig?; /** * A list of inputs for the monitoring job. */ private _dataQualityJobInput; /** * The output configuration for monitoring jobs. */ private _dataQualityJobOutputConfig; /** * The name of the endpoint used to run the monitoring job. */ private _endpointName?; /** * The name for the monitoring job definition. */ private _jobDefinitionName?; /** * Identifies the resources to deploy for a monitoring job. */ private _jobResources; /** * Specifies networking configuration for the monitoring job. */ private _networkConfig?; /** * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. */ private _roleArn; /** * A time limit for how long the monitoring job is allowed to run before stopping. */ private _stoppingCondition?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * An array of key-value pairs to apply to this resource. */ private _tagsRaw?; /** * Create a new `AWS::SageMaker::DataQualityJobDefinition`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDataQualityJobDefinitionProps); get dataQualityJobDefinitionRef(): DataQualityJobDefinitionReference; /** * Specifies the container that runs the monitoring job. */ get dataQualityAppSpecification(): CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty | cdk.IResolvable; /** * Specifies the container that runs the monitoring job. */ set dataQualityAppSpecification(value: CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty | cdk.IResolvable); /** * Configures the constraints and baselines for the monitoring job. */ get dataQualityBaselineConfig(): CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty | cdk.IResolvable | undefined; /** * Configures the constraints and baselines for the monitoring job. */ set dataQualityBaselineConfig(value: CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty | cdk.IResolvable | undefined); /** * A list of inputs for the monitoring job. */ get dataQualityJobInput(): CfnDataQualityJobDefinition.DataQualityJobInputProperty | cdk.IResolvable; /** * A list of inputs for the monitoring job. */ set dataQualityJobInput(value: CfnDataQualityJobDefinition.DataQualityJobInputProperty | cdk.IResolvable); /** * The output configuration for monitoring jobs. */ get dataQualityJobOutputConfig(): cdk.IResolvable | CfnDataQualityJobDefinition.MonitoringOutputConfigProperty; /** * The output configuration for monitoring jobs. */ set dataQualityJobOutputConfig(value: cdk.IResolvable | CfnDataQualityJobDefinition.MonitoringOutputConfigProperty); /** * The name of the endpoint used to run the monitoring job. */ get endpointName(): string | undefined; /** * The name of the endpoint used to run the monitoring job. */ set endpointName(value: string | undefined); /** * The name for the monitoring job definition. */ get jobDefinitionName(): string | undefined; /** * The name for the monitoring job definition. */ set jobDefinitionName(value: string | undefined); /** * Identifies the resources to deploy for a monitoring job. */ get jobResources(): cdk.IResolvable | CfnDataQualityJobDefinition.MonitoringResourcesProperty; /** * Identifies the resources to deploy for a monitoring job. */ set jobResources(value: cdk.IResolvable | CfnDataQualityJobDefinition.MonitoringResourcesProperty); /** * Specifies networking configuration for the monitoring job. */ get networkConfig(): cdk.IResolvable | CfnDataQualityJobDefinition.NetworkConfigProperty | undefined; /** * Specifies networking configuration for the monitoring job. */ set networkConfig(value: cdk.IResolvable | CfnDataQualityJobDefinition.NetworkConfigProperty | undefined); /** * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. */ get roleArn(): string; /** * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. */ set roleArn(value: string); /** * A time limit for how long the monitoring job is allowed to run before stopping. */ get stoppingCondition(): cdk.IResolvable | CfnDataQualityJobDefinition.StoppingConditionProperty | undefined; /** * A time limit for how long the monitoring job is allowed to run before stopping. */ set stoppingCondition(value: cdk.IResolvable | CfnDataQualityJobDefinition.StoppingConditionProperty | undefined); /** * An array of key-value pairs to apply to this resource. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * An array of key-value pairs to apply to this resource. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The time when the job definition was created. * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The Amazon Resource Name (ARN) of the job definition. * * @cloudformationAttribute JobDefinitionArn */ get attrJobDefinitionArn(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnDataQualityJobDefinition { /** * The input for the data quality monitoring job. * * Currently endpoints are supported for input. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html */ interface DataQualityJobInputProperty { /** * 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 */ readonly batchTransformInput?: CfnDataQualityJobDefinition.BatchTransformInputProperty | cdk.IResolvable; /** * 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 */ readonly endpointInput?: CfnDataQualityJobDefinition.EndpointInputProperty | cdk.IResolvable; } /** * Input object for the batch transform job. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html */ interface BatchTransformInputProperty { /** * 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 */ readonly dataCapturedDestinationS3Uri: string; /** * 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 */ readonly datasetFormat: CfnDataQualityJobDefinition.DatasetFormatProperty | cdk.IResolvable; /** * 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 */ readonly excludeFeaturesAttribute?: string; /** * 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 */ readonly localPath: string; /** * 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 */ readonly s3DataDistributionType?: string; /** * 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 */ readonly s3InputMode?: string; } /** * The dataset format of the data to monitor. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html */ interface DatasetFormatProperty { /** * The CSV format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-csv */ readonly csv?: CfnDataQualityJobDefinition.CsvProperty | cdk.IResolvable; /** * The Json format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html#cfn-sagemaker-dataqualityjobdefinition-datasetformat-json */ readonly json?: cdk.IResolvable | CfnDataQualityJobDefinition.JsonProperty; /** * 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 */ readonly parquet?: boolean | cdk.IResolvable; } /** * The CSV format. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html */ interface CsvProperty { /** * 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 */ readonly header?: boolean | cdk.IResolvable; } /** * The Json format. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html */ interface JsonProperty { /** * 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 */ readonly line?: boolean | cdk.IResolvable; } /** * Input object for the endpoint. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html */ interface EndpointInputProperty { /** * 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 */ readonly endpointName: string; /** * 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 */ readonly excludeFeaturesAttribute?: string; /** * 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-dataqu