Struct aws_sdk_sagemaker::operation::describe_domain::DescribeDomainOutput

#[non_exhaustive]
pub struct DescribeDomainOutput {

    pub domain_arn: Option<String>,
    pub domain_id: Option<String>,
    pub domain_name: Option<String>,
    pub home_efs_file_system_id: Option<String>,
    pub single_sign_on_managed_application_instance_id: Option<String>,
    pub single_sign_on_application_arn: Option<String>,
    pub status: Option<DomainStatus>,
    pub creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub failure_reason: Option<String>,
    pub security_group_id_for_domain_boundary: Option<String>,
    pub auth_mode: Option<AuthMode>,
    pub default_user_settings: Option<UserSettings>,
    pub domain_settings: Option<DomainSettings>,
    pub app_network_access_type: Option<AppNetworkAccessType>,
    pub home_efs_file_system_kms_key_id: Option<String>,
    pub subnet_ids: Option<Vec<String>>,
    pub url: Option<String>,
    pub vpc_id: Option<String>,
    pub kms_key_id: Option<String>,
    pub app_security_group_management: Option<AppSecurityGroupManagement>,
    pub default_space_settings: Option<DefaultSpaceSettings>,
    /* private fields */
}

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.

domain_arn: Option<String>

The domain's Amazon Resource Name (ARN).

domain_id: Option<String>

The domain ID.

domain_name: Option<String>

The domain name.

home_efs_file_system_id: Option<String>

The ID of the Amazon Elastic File System managed by this Domain.

single_sign_on_managed_application_instance_id: Option<String>

The IAM Identity Center managed application instance ID.

single_sign_on_application_arn: Option<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.

status: Option<DomainStatus>

The status.

creation_time: Option<DateTime>

The creation time.

last_modified_time: Option<DateTime>

The last modified time.

failure_reason: Option<String>

The failure reason.

security_group_id_for_domain_boundary: Option<String>

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

auth_mode: Option<AuthMode>

The domain's authentication mode.

default_user_settings: Option<UserSettings>

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

domain_settings: Option<DomainSettings>

A collection of Domain settings.

app_network_access_type: Option<AppNetworkAccessType>

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 traffic is through the specified VPC and subnets

home_efs_file_system_kms_key_id: Option<String>

👎Deprecated: This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

subnet_ids: Option<Vec<String>>

The VPC subnets that the domain uses for communication.

url: Option<String>

The domain's URL.

vpc_id: Option<String>

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

kms_key_id: Option<String>

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

app_security_group_management: Option<AppSecurityGroupManagement>

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.

default_space_settings: Option<DefaultSpaceSettings>

The default settings used to create a space.

Implementations

impl DescribeDomainOutput

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

The domain's Amazon Resource Name (ARN).

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

The domain ID.

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

The domain name.

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

The ID of the Amazon Elastic File System managed by this Domain.

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

The IAM Identity Center managed application instance ID.

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

The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.

pub fn status(&self) -> Option<&DomainStatus>

The status.

pub fn creation_time(&self) -> Option<&DateTime>

The creation time.

pub fn last_modified_time(&self) -> Option<&DateTime>

The last modified time.

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

The failure reason.

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

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

pub fn auth_mode(&self) -> Option<&AuthMode>

The domain's authentication mode.

pub fn default_user_settings(&self) -> Option<&UserSettings>

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

pub fn domain_settings(&self) -> Option<&DomainSettings>

A collection of Domain settings.

pub fn app_network_access_type(&self) -> Option<&AppNetworkAccessType>

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 traffic is through the specified VPC and subnets

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

👎Deprecated: This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

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

The VPC subnets that the domain uses for communication.

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

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

The domain's URL.

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

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

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

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

pub fn app_security_group_management( &self, ) -> Option<&AppSecurityGroupManagement>

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.

pub fn default_space_settings(&self) -> Option<&DefaultSpaceSettings>

The default settings used to create a space.

impl DescribeDomainOutput

pub fn builder() -> DescribeDomainOutputBuilder

Creates a new builder-style object to manufacture DescribeDomainOutput.

Trait Implementations

impl Clone for DescribeDomainOutput

fn clone(&self) -> DescribeDomainOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDomainOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeDomainOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for DescribeDomainOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeDomainOutput