#[non_exhaustive]pub struct CreatePortalInputBuilder { /* private fields */ }Expand description
A builder for CreatePortalInput.
Implementations§
Source§impl CreatePortalInputBuilder
impl CreatePortalInputBuilder
Sourcepub fn portal_name(self, input: impl Into<String>) -> Self
pub fn portal_name(self, input: impl Into<String>) -> Self
A friendly name for the portal.
This field is required.Sourcepub fn set_portal_name(self, input: Option<String>) -> Self
pub fn set_portal_name(self, input: Option<String>) -> Self
A friendly name for the portal.
Sourcepub fn get_portal_name(&self) -> &Option<String>
pub fn get_portal_name(&self) -> &Option<String>
A friendly name for the portal.
Sourcepub fn portal_description(self, input: impl Into<String>) -> Self
pub fn portal_description(self, input: impl Into<String>) -> Self
A description for the portal.
Sourcepub fn set_portal_description(self, input: Option<String>) -> Self
pub fn set_portal_description(self, input: Option<String>) -> Self
A description for the portal.
Sourcepub fn get_portal_description(&self) -> &Option<String>
pub fn get_portal_description(&self) -> &Option<String>
A description for the portal.
Sourcepub fn portal_contact_email(self, input: impl Into<String>) -> Self
pub fn portal_contact_email(self, input: impl Into<String>) -> Self
The Amazon Web Services administrator's contact email address.
This field is required.Sourcepub fn set_portal_contact_email(self, input: Option<String>) -> Self
pub fn set_portal_contact_email(self, input: Option<String>) -> Self
The Amazon Web Services administrator's contact email address.
Sourcepub fn get_portal_contact_email(&self) -> &Option<String>
pub fn get_portal_contact_email(&self) -> &Option<String>
The Amazon Web Services administrator's contact email address.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Sourcepub fn portal_logo_image_file(self, input: ImageFile) -> Self
pub fn portal_logo_image_file(self, input: ImageFile) -> Self
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
Sourcepub fn set_portal_logo_image_file(self, input: Option<ImageFile>) -> Self
pub fn set_portal_logo_image_file(self, input: Option<ImageFile>) -> Self
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
Sourcepub fn get_portal_logo_image_file(&self) -> &Option<ImageFile>
pub fn get_portal_logo_image_file(&self) -> &Option<ImageFile>
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
Sourcepub fn portal_auth_mode(self, input: AuthMode) -> Self
pub fn portal_auth_mode(self, input: AuthMode) -> Self
The service to use to authenticate users to the portal. Choose from the following options:
-
SSO– The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. -
IAM– The portal uses Identity and Access Management to authenticate users and manage user permissions.
You can't change this value after you create a portal.
Default: SSO
Sourcepub fn set_portal_auth_mode(self, input: Option<AuthMode>) -> Self
pub fn set_portal_auth_mode(self, input: Option<AuthMode>) -> Self
The service to use to authenticate users to the portal. Choose from the following options:
-
SSO– The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. -
IAM– The portal uses Identity and Access Management to authenticate users and manage user permissions.
You can't change this value after you create a portal.
Default: SSO
Sourcepub fn get_portal_auth_mode(&self) -> &Option<AuthMode>
pub fn get_portal_auth_mode(&self) -> &Option<AuthMode>
The service to use to authenticate users to the portal. Choose from the following options:
-
SSO– The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. -
IAM– The portal uses Identity and Access Management to authenticate users and manage user permissions.
You can't change this value after you create a portal.
Default: SSO
Sourcepub fn notification_sender_email(self, input: impl Into<String>) -> Self
pub fn notification_sender_email(self, input: impl Into<String>) -> Self
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
Sourcepub fn set_notification_sender_email(self, input: Option<String>) -> Self
pub fn set_notification_sender_email(self, input: Option<String>) -> Self
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
Sourcepub fn get_notification_sender_email(&self) -> &Option<String>
pub fn get_notification_sender_email(&self) -> &Option<String>
The email address that sends alarm notifications.
If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
Sourcepub fn alarms(self, input: Alarms) -> Self
pub fn alarms(self, input: Alarms) -> Self
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
Sourcepub fn set_alarms(self, input: Option<Alarms>) -> Self
pub fn set_alarms(self, input: Option<Alarms>) -> Self
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
Sourcepub fn get_alarms(&self) -> &Option<Alarms>
pub fn get_alarms(&self) -> &Option<Alarms>
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
Sourcepub fn portal_type(self, input: PortalType) -> Self
pub fn portal_type(self, input: PortalType) -> Self
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Sourcepub fn set_portal_type(self, input: Option<PortalType>) -> Self
pub fn set_portal_type(self, input: Option<PortalType>) -> Self
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Sourcepub fn get_portal_type(&self) -> &Option<PortalType>
pub fn get_portal_type(&self) -> &Option<PortalType>
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Sourcepub fn portal_type_configuration(
self,
k: impl Into<String>,
v: PortalTypeEntry,
) -> Self
pub fn portal_type_configuration( self, k: impl Into<String>, v: PortalTypeEntry, ) -> Self
Adds a key-value pair to portal_type_configuration.
To override the contents of this collection use set_portal_type_configuration.
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Sourcepub fn set_portal_type_configuration(
self,
input: Option<HashMap<String, PortalTypeEntry>>,
) -> Self
pub fn set_portal_type_configuration( self, input: Option<HashMap<String, PortalTypeEntry>>, ) -> Self
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Sourcepub fn get_portal_type_configuration(
&self,
) -> &Option<HashMap<String, PortalTypeEntry>>
pub fn get_portal_type_configuration( &self, ) -> &Option<HashMap<String, PortalTypeEntry>>
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
Sourcepub fn build(self) -> Result<CreatePortalInput, BuildError>
pub fn build(self) -> Result<CreatePortalInput, BuildError>
Consumes the builder and constructs a CreatePortalInput.
Source§impl CreatePortalInputBuilder
impl CreatePortalInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreatePortalOutput, SdkError<CreatePortalError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreatePortalOutput, SdkError<CreatePortalError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreatePortalInputBuilder
impl Clone for CreatePortalInputBuilder
Source§fn clone(&self) -> CreatePortalInputBuilder
fn clone(&self) -> CreatePortalInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreatePortalInputBuilder
impl Debug for CreatePortalInputBuilder
Source§impl Default for CreatePortalInputBuilder
impl Default for CreatePortalInputBuilder
Source§fn default() -> CreatePortalInputBuilder
fn default() -> CreatePortalInputBuilder
Source§impl PartialEq for CreatePortalInputBuilder
impl PartialEq for CreatePortalInputBuilder
impl StructuralPartialEq for CreatePortalInputBuilder
Auto Trait Implementations§
impl Freeze for CreatePortalInputBuilder
impl RefUnwindSafe for CreatePortalInputBuilder
impl Send for CreatePortalInputBuilder
impl Sync for CreatePortalInputBuilder
impl Unpin for CreatePortalInputBuilder
impl UnwindSafe for CreatePortalInputBuilder
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);