Struct CodeEditorAppSettings

#[non_exhaustive]
pub struct CodeEditorAppSettings {
    pub default_resource_spec: Option<ResourceSpec>,
    pub custom_images: Option<Vec<CustomImage>>,
    pub lifecycle_config_arns: Option<Vec<String>>,
    pub app_lifecycle_management: Option<AppLifecycleManagement>,
    pub built_in_lifecycle_config_arn: Option<String>,
}

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

default_resource_spec: Option<ResourceSpec>

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.

custom_images: Option<Vec<CustomImage>>

A list of custom SageMaker images that are configured to run as a Code Editor app.

lifecycle_config_arns: Option<Vec<String>>

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

app_lifecycle_management: Option<AppLifecycleManagement>

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

built_in_lifecycle_config_arn: Option<String>

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

Implementations

impl CodeEditorAppSettings

pub fn default_resource_spec(&self) -> Option<&ResourceSpec>

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.

pub fn custom_images(&self) -> &[CustomImage]

A list of custom SageMaker images that are configured to run as a Code Editor app.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_images.is_none().

pub fn lifecycle_config_arns(&self) -> &[String]

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .lifecycle_config_arns.is_none().

pub fn app_lifecycle_management(&self) -> Option<&AppLifecycleManagement>

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

pub fn built_in_lifecycle_config_arn(&self) -> Option<&str>

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

impl CodeEditorAppSettings

pub fn builder() -> CodeEditorAppSettingsBuilder

Creates a new builder-style object to manufacture CodeEditorAppSettings.

Trait Implementations

impl Clone for CodeEditorAppSettings

fn clone(&self) -> CodeEditorAppSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodeEditorAppSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CodeEditorAppSettings

fn eq(&self, other: &CodeEditorAppSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CodeEditorAppSettings