#[non_exhaustive]pub struct CreateDomainInput {Show 13 fields
pub domain_name: Option<String>,
pub auth_mode: Option<AuthMode>,
pub default_user_settings: Option<UserSettings>,
pub domain_settings: Option<DomainSettings>,
pub subnet_ids: Option<Vec<String>>,
pub vpc_id: Option<String>,
pub tags: Option<Vec<Tag>>,
pub app_network_access_type: Option<AppNetworkAccessType>,
pub home_efs_file_system_kms_key_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>,
}
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_name: Option<String>
A name for the domain.
auth_mode: Option<AuthMode>
The mode of authentication that members use to access the domain.
default_user_settings: Option<UserSettings>
The default settings to use to create a user profile when UserSettings
isn't specified in the call to the CreateUserProfile
API.
SecurityGroups
is aggregated when specified in both calls. For all other settings in UserSettings
, the values specified in CreateUserProfile
take precedence over those specified in CreateDomain
.
domain_settings: Option<DomainSettings>
A collection of Domain
settings.
subnet_ids: Option<Vec<String>>
The VPC subnets that the domain uses for communication.
vpc_id: Option<String>
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search
API.
Tags that you specify for the Domain are also added to all Apps that the Domain launches.
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
.
kms_key_id: Option<String>
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
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. If setting up the domain for use with RStudio, this value must be set to Service
.
tag_propagation: Option<TagPropagation>
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED
.
default_space_settings: Option<DefaultSpaceSettings>
The default settings for shared spaces that users create in the domain.
Implementations§
Source§impl CreateDomainInput
impl CreateDomainInput
Sourcepub fn domain_name(&self) -> Option<&str>
pub fn domain_name(&self) -> Option<&str>
A name for the domain.
Sourcepub fn auth_mode(&self) -> Option<&AuthMode>
pub fn auth_mode(&self) -> Option<&AuthMode>
The mode of authentication that members use to access the domain.
Sourcepub fn default_user_settings(&self) -> Option<&UserSettings>
pub fn default_user_settings(&self) -> Option<&UserSettings>
The default settings to use to create a user profile when UserSettings
isn't specified in the call to the CreateUserProfile
API.
SecurityGroups
is aggregated when specified in both calls. For all other settings in UserSettings
, the values specified in CreateUserProfile
take precedence over those specified in CreateDomain
.
Sourcepub fn domain_settings(&self) -> Option<&DomainSettings>
pub fn domain_settings(&self) -> Option<&DomainSettings>
A collection of Domain
settings.
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.
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search
API.
Tags that you specify for the Domain are also added to all Apps that the Domain launches.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
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 kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
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. If setting up the domain for use with RStudio, this value must be set to Service
.
Sourcepub fn tag_propagation(&self) -> Option<&TagPropagation>
pub fn tag_propagation(&self) -> Option<&TagPropagation>
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED
.
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 CreateDomainInput
impl CreateDomainInput
Sourcepub fn builder() -> CreateDomainInputBuilder
pub fn builder() -> CreateDomainInputBuilder
Creates a new builder-style object to manufacture CreateDomainInput
.
Trait Implementations§
Source§impl Clone for CreateDomainInput
impl Clone for CreateDomainInput
Source§fn clone(&self) -> CreateDomainInput
fn clone(&self) -> CreateDomainInput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateDomainInput
impl Debug for CreateDomainInput
Source§impl PartialEq for CreateDomainInput
impl PartialEq for CreateDomainInput
impl StructuralPartialEq for CreateDomainInput
Auto Trait Implementations§
impl Freeze for CreateDomainInput
impl RefUnwindSafe for CreateDomainInput
impl Send for CreateDomainInput
impl Sync for CreateDomainInput
impl Unpin for CreateDomainInput
impl UnwindSafe for CreateDomainInput
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);