CfnAppProps

class aws_cdk.aws_sagemaker.CfnAppProps(*, app_name, app_type, domain_id, user_profile_name, resource_spec=None, tags=None)

Bases: object

Properties for defining a CfnApp.

Parameters
  • app_name (str) – The name of the app.

  • app_type (str) – The type of app. Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas

  • domain_id (str) – The domain ID.

  • user_profile_name (str) – The user profile name.

  • resource_spec (Union[ResourceSpecProperty, IResolvable, None]) – Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

  • tags (Optional[Sequence[CfnTag]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sagemaker as sagemaker

cfn_app_props = sagemaker.CfnAppProps(
    app_name="appName",
    app_type="appType",
    domain_id="domainId",
    user_profile_name="userProfileName",

    # the properties below are optional
    resource_spec=sagemaker.CfnApp.ResourceSpecProperty(
        instance_type="instanceType",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

app_name

The name of the app.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-appname

Return type

str

app_type

The type of app.

Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-apptype

Return type

str

domain_id

The domain ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-domainid

Return type

str

resource_spec

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-resourcespec

Return type

Union[ResourceSpecProperty, IResolvable, None]

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

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

Return type

Optional[List[CfnTag]]

user_profile_name

The user profile name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html#cfn-sagemaker-app-userprofilename

Return type

str