CfnUserProfile
- class aws_cdk.aws_sagemaker.CfnUserProfile(scope, id, *, domain_id, user_profile_name, single_sign_on_user_identifier=None, single_sign_on_user_value=None, tags=None, user_settings=None)
Bases:
CfnResource
A CloudFormation
AWS::SageMaker::UserProfile
.Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a “person” for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from 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. .. epigraph:
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.
- CloudformationResource:
AWS::SageMaker::UserProfile
- Link:
- 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_user_profile = sagemaker.CfnUserProfile(self, "MyCfnUserProfile", domain_id="domainId", user_profile_name="userProfileName", # the properties below are optional single_sign_on_user_identifier="singleSignOnUserIdentifier", single_sign_on_user_value="singleSignOnUserValue", tags=[CfnTag( key="key", value="value" )], user_settings=sagemaker.CfnUserProfile.UserSettingsProperty( execution_role="executionRole", jupyter_server_app_settings=sagemaker.CfnUserProfile.JupyterServerAppSettingsProperty( default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) ), kernel_gateway_app_settings=sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty( custom_images=[sagemaker.CfnUserProfile.CustomImageProperty( app_image_config_name="appImageConfigName", image_name="imageName", # the properties below are optional image_version_number=123 )], default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) ), r_studio_server_pro_app_settings=sagemaker.CfnUserProfile.RStudioServerProAppSettingsProperty( access_status="accessStatus", user_group="userGroup" ), security_groups=["securityGroups"], sharing_settings=sagemaker.CfnUserProfile.SharingSettingsProperty( notebook_output_option="notebookOutputOption", s3_kms_key_id="s3KmsKeyId", s3_output_path="s3OutputPath" ) ) )
Create a new
AWS::SageMaker::UserProfile
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
domain_id (
str
) – The domain ID.user_profile_name (
str
) – The user profile name.single_sign_on_user_identifier (
Optional
[str
]) – 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.single_sign_on_user_value (
Optional
[str
]) – 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.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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 .user_settings (
Union
[IResolvable
,UserSettingsProperty
,Dict
[str
,Any
],None
]) – A collection of settings that apply to users of Amazon SageMaker Studio.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource
)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
)value (
Any
)
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::SageMaker::UserProfile'
- attr_user_profile_arn
The Amazon Resource Name (ARN) of the user profile, such as
arn:aws:sagemaker:us-west-2:account-id:user-profile/my-user-profile
.- CloudformationAttribute:
UserProfileArn
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
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.
- domain_id
The domain ID.
- logical_id
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.
- node
The construct tree node associated with this construct.
- ref
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 })
.
- single_sign_on_user_identifier
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.
- single_sign_on_user_value
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.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
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 .
- user_profile_name
The user profile name.
- user_settings
A collection of settings that apply to users of Amazon SageMaker Studio.
Static Methods
- classmethod is_cfn_element(x)
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.- Parameters:
x (
Any
)- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
CustomImageProperty
- class CfnUserProfile.CustomImageProperty(*, app_image_config_name, image_name, image_version_number=None)
Bases:
object
A custom SageMaker image.
For more information, see Bring your own SageMaker image .
- Parameters:
app_image_config_name (
str
) – The name of the AppImageConfig.image_name (
str
) – The name of the CustomImage. Must be unique to your account.image_version_number (
Union
[int
,float
,None
]) – The version number of the CustomImage.
- Link:
- 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 custom_image_property = sagemaker.CfnUserProfile.CustomImageProperty( app_image_config_name="appImageConfigName", image_name="imageName", # the properties below are optional image_version_number=123 )
Attributes
- app_image_config_name
The name of the AppImageConfig.
- image_name
The name of the CustomImage.
Must be unique to your account.
- image_version_number
The version number of the CustomImage.
JupyterServerAppSettingsProperty
- class CfnUserProfile.JupyterServerAppSettingsProperty(*, default_resource_spec=None)
Bases:
object
The JupyterServer app settings.
- Parameters:
default_resource_spec (
Union
[IResolvable
,ResourceSpecProperty
,Dict
[str
,Any
],None
]) – The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.- Link:
- 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 jupyter_server_app_settings_property = sagemaker.CfnUserProfile.JupyterServerAppSettingsProperty( default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) )
Attributes
- default_resource_spec
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
KernelGatewayAppSettingsProperty
- class CfnUserProfile.KernelGatewayAppSettingsProperty(*, custom_images=None, default_resource_spec=None)
Bases:
object
The KernelGateway app settings.
- Parameters:
custom_images (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,CustomImageProperty
,Dict
[str
,Any
]]],None
]) – A list of custom SageMaker images that are configured to run as a KernelGateway app.default_resource_spec (
Union
[IResolvable
,ResourceSpecProperty
,Dict
[str
,Any
],None
]) – The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. .. epigraph:: 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 Command Line Interface or AWS CloudFormation and the instance type parameter value is not passed.
- Link:
- 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 kernel_gateway_app_settings_property = sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty( custom_images=[sagemaker.CfnUserProfile.CustomImageProperty( app_image_config_name="appImageConfigName", image_name="imageName", # the properties below are optional image_version_number=123 )], default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) )
Attributes
- custom_images
A list of custom SageMaker images that are configured to run as a KernelGateway app.
- default_resource_spec
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 Command Line Interface or AWS CloudFormation and the instance type parameter value is not passed.
RStudioServerProAppSettingsProperty
- class CfnUserProfile.RStudioServerProAppSettingsProperty(*, access_status=None, user_group=None)
Bases:
object
A collection of settings that configure user interaction with the
RStudioServerPro
app.- Parameters:
access_status (
Optional
[str
]) – Indicates whether the current user has access to theRStudioServerPro
app.user_group (
Optional
[str
]) – The level of permissions that the user has within theRStudioServerPro
app. This value defaults toUser
. TheAdmin
value allows the user access to the RStudio Administrative Dashboard.
- Link:
- 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 r_studio_server_pro_app_settings_property = sagemaker.CfnUserProfile.RStudioServerProAppSettingsProperty( access_status="accessStatus", user_group="userGroup" )
Attributes
- access_status
Indicates whether the current user has access to the
RStudioServerPro
app.
- user_group
The level of permissions that the user has within the
RStudioServerPro
app.This value defaults to
User
. TheAdmin
value allows the user access to the RStudio Administrative Dashboard.
ResourceSpecProperty
- class CfnUserProfile.ResourceSpecProperty(*, instance_type=None, sage_maker_image_arn=None, sage_maker_image_version_arn=None)
Bases:
object
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
- Parameters:
instance_type (
Optional
[str
]) – The instance type that the image version runs on. .. epigraph:: JupyterServer apps only support thesystem
value. For KernelGateway apps , thesystem
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.sage_maker_image_arn (
Optional
[str
]) – The ARN of the SageMaker image that the image version belongs to.sage_maker_image_version_arn (
Optional
[str
]) – The ARN of the image version created on the instance.
- Link:
- 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 resource_spec_property = sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" )
Attributes
- instance_type
The instance type that the image version runs on.
JupyterServer apps only support the
system
value.For KernelGateway apps , the
system
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.
- sage_maker_image_arn
The ARN of the SageMaker image that the image version belongs to.
- sage_maker_image_version_arn
The ARN of the image version created on the instance.
UserSettingsProperty
- class CfnUserProfile.UserSettingsProperty(*, execution_role=None, jupyter_server_app_settings=None, kernel_gateway_app_settings=None, r_studio_server_pro_app_settings=None, security_groups=None, sharing_settings=None)
Bases:
object
A collection of settings that apply to users of Amazon SageMaker Studio.
These settings are specified when the CreateUserProfile API is called, and as
DefaultUserSettings
when the CreateDomain API is called.SecurityGroups
is aggregated when specified in both calls. For all other settings inUserSettings
, the values specified inCreateUserProfile
take precedence over those specified inCreateDomain
.- Parameters:
execution_role (
Optional
[str
]) – The execution role for the user.jupyter_server_app_settings (
Union
[IResolvable
,JupyterServerAppSettingsProperty
,Dict
[str
,Any
],None
]) – The Jupyter server’s app settings.kernel_gateway_app_settings (
Union
[IResolvable
,KernelGatewayAppSettingsProperty
,Dict
[str
,Any
],None
]) – The kernel gateway app settings.r_studio_server_pro_app_settings (
Union
[IResolvable
,RStudioServerProAppSettingsProperty
,Dict
[str
,Any
],None
]) – A collection of settings that configure user interaction with theRStudioServerPro
app.security_groups (
Optional
[Sequence
[str
]]) – The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. Optional when theCreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
. Required when theCreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
for the domain. Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.sharing_settings (
Union
[IResolvable
,SharingSettingsProperty
,Dict
[str
,Any
],None
]) – Specifies options for sharing SageMaker Studio notebooks.
- Link:
- 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 user_settings_property = sagemaker.CfnUserProfile.UserSettingsProperty( execution_role="executionRole", jupyter_server_app_settings=sagemaker.CfnUserProfile.JupyterServerAppSettingsProperty( default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) ), kernel_gateway_app_settings=sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty( custom_images=[sagemaker.CfnUserProfile.CustomImageProperty( app_image_config_name="appImageConfigName", image_name="imageName", # the properties below are optional image_version_number=123 )], default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) ), r_studio_server_pro_app_settings=sagemaker.CfnUserProfile.RStudioServerProAppSettingsProperty( access_status="accessStatus", user_group="userGroup" ), security_groups=["securityGroups"], sharing_settings=sagemaker.CfnUserProfile.SharingSettingsProperty( notebook_output_option="notebookOutputOption", s3_kms_key_id="s3KmsKeyId", s3_output_path="s3OutputPath" ) )
Attributes
- execution_role
The execution role for the user.
- jupyter_server_app_settings
The Jupyter server’s app settings.
- kernel_gateway_app_settings
The kernel gateway app settings.
- r_studio_server_pro_app_settings
A collection of settings that configure user interaction with the
RStudioServerPro
app.
- security_groups
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the
CreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
.Required when the
CreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
for the domain.Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
- sharing_settings
Specifies options for sharing SageMaker Studio notebooks.