#[non_exhaustive]pub struct DescribeDomainOutput {Show 23 fields
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 tag_propagation: Option<TagPropagation>,
pub default_space_settings: Option<DefaultSpaceSettings>,
/* private fields */
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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 AI 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 AI, which allows direct internet access -
VpcOnly- All traffic is through the specified VPC and subnets
home_efs_file_system_kms_key_id: Option<String>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.
tag_propagation: Option<TagPropagation>Indicates whether custom tag propagation is supported for the domain.
default_space_settings: Option<DefaultSpaceSettings>The default settings for shared spaces that users create in the domain.
Implementations§
Source§impl DescribeDomainOutput
impl DescribeDomainOutput
Sourcepub fn domain_arn(&self) -> Option<&str>
pub fn domain_arn(&self) -> Option<&str>
The domain's Amazon Resource Name (ARN).
Sourcepub fn domain_name(&self) -> Option<&str>
pub fn domain_name(&self) -> Option<&str>
The domain name.
Sourcepub fn home_efs_file_system_id(&self) -> Option<&str>
pub fn home_efs_file_system_id(&self) -> Option<&str>
The ID of the Amazon Elastic File System managed by this Domain.
Sourcepub fn single_sign_on_managed_application_instance_id(&self) -> Option<&str>
pub fn single_sign_on_managed_application_instance_id(&self) -> Option<&str>
The IAM Identity Center managed application instance ID.
Sourcepub fn single_sign_on_application_arn(&self) -> Option<&str>
pub fn single_sign_on_application_arn(&self) -> Option<&str>
The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
Sourcepub fn status(&self) -> Option<&DomainStatus>
pub fn status(&self) -> Option<&DomainStatus>
The status.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The creation time.
Sourcepub fn last_modified_time(&self) -> Option<&DateTime>
pub fn last_modified_time(&self) -> Option<&DateTime>
The last modified time.
Sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
The failure reason.
Sourcepub fn security_group_id_for_domain_boundary(&self) -> Option<&str>
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.
Sourcepub fn default_user_settings(&self) -> Option<&UserSettings>
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.
Sourcepub fn domain_settings(&self) -> Option<&DomainSettings>
pub fn domain_settings(&self) -> Option<&DomainSettings>
A collection of Domain settings.
Sourcepub fn app_network_access_type(&self) -> Option<&AppNetworkAccessType>
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 AI, which allows direct internet access -
VpcOnly- All traffic is through the specified VPC and subnets
Sourcepub fn home_efs_file_system_kms_key_id(&self) -> Option<&str>
👎Deprecated: This property is deprecated, use KmsKeyId instead.
pub fn home_efs_file_system_kms_key_id(&self) -> Option<&str>
Use KmsKeyId.
Sourcepub fn subnet_ids(&self) -> &[String]
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().
Sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Sourcepub fn kms_key_id(&self) -> Option<&str>
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.
Sourcepub fn app_security_group_management(
&self,
) -> Option<&AppSecurityGroupManagement>
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.
Sourcepub fn tag_propagation(&self) -> Option<&TagPropagation>
pub fn tag_propagation(&self) -> Option<&TagPropagation>
Indicates whether custom tag propagation is supported for the domain.
Sourcepub fn default_space_settings(&self) -> Option<&DefaultSpaceSettings>
pub fn default_space_settings(&self) -> Option<&DefaultSpaceSettings>
The default settings for shared spaces that users create in the domain.
Source§impl DescribeDomainOutput
impl DescribeDomainOutput
Sourcepub fn builder() -> DescribeDomainOutputBuilder
pub fn builder() -> DescribeDomainOutputBuilder
Creates a new builder-style object to manufacture DescribeDomainOutput.
Trait Implementations§
Source§impl Clone for DescribeDomainOutput
impl Clone for DescribeDomainOutput
Source§fn clone(&self) -> DescribeDomainOutput
fn clone(&self) -> DescribeDomainOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DescribeDomainOutput
impl Debug for DescribeDomainOutput
Source§impl PartialEq for DescribeDomainOutput
impl PartialEq for DescribeDomainOutput
Source§impl RequestId for DescribeDomainOutput
impl RequestId for DescribeDomainOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for DescribeDomainOutput
Auto Trait Implementations§
impl Freeze for DescribeDomainOutput
impl RefUnwindSafe for DescribeDomainOutput
impl Send for DescribeDomainOutput
impl Sync for DescribeDomainOutput
impl Unpin for DescribeDomainOutput
impl UnwindSafe for DescribeDomainOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);