pub struct CreateSystemInstanceFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateSystemInstance.
Creates a system instance.
This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.
For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.
For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.
If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.
Implementations§
Source§impl CreateSystemInstanceFluentBuilder
impl CreateSystemInstanceFluentBuilder
Sourcepub fn as_input(&self) -> &CreateSystemInstanceInputBuilder
pub fn as_input(&self) -> &CreateSystemInstanceInputBuilder
Access the CreateSystemInstance as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateSystemInstanceOutput, SdkError<CreateSystemInstanceError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateSystemInstanceOutput, SdkError<CreateSystemInstanceError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateSystemInstanceOutput, CreateSystemInstanceError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateSystemInstanceOutput, CreateSystemInstanceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Appends an item to tags.
To override the contents of this collection use set_tags.
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
Sourcepub fn definition(self, input: DefinitionDocument) -> Self
pub fn definition(self, input: DefinitionDocument) -> Self
A document that defines an entity.
Sourcepub fn set_definition(self, input: Option<DefinitionDocument>) -> Self
pub fn set_definition(self, input: Option<DefinitionDocument>) -> Self
A document that defines an entity.
Sourcepub fn get_definition(&self) -> &Option<DefinitionDocument>
pub fn get_definition(&self) -> &Option<DefinitionDocument>
A document that defines an entity.
Sourcepub fn target(self, input: DeploymentTarget) -> Self
pub fn target(self, input: DeploymentTarget) -> Self
The target type of the deployment. Valid values are GREENGRASS and CLOUD.
Sourcepub fn set_target(self, input: Option<DeploymentTarget>) -> Self
pub fn set_target(self, input: Option<DeploymentTarget>) -> Self
The target type of the deployment. Valid values are GREENGRASS and CLOUD.
Sourcepub fn get_target(&self) -> &Option<DeploymentTarget>
pub fn get_target(&self) -> &Option<DeploymentTarget>
The target type of the deployment. Valid values are GREENGRASS and CLOUD.
Sourcepub fn greengrass_group_name(self, input: impl Into<String>) -> Self
pub fn greengrass_group_name(self, input: impl Into<String>) -> Self
The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.
Sourcepub fn set_greengrass_group_name(self, input: Option<String>) -> Self
pub fn set_greengrass_group_name(self, input: Option<String>) -> Self
The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.
Sourcepub fn get_greengrass_group_name(&self) -> &Option<String>
pub fn get_greengrass_group_name(&self) -> &Option<String>
The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.
Sourcepub fn s3_bucket_name(self, input: impl Into<String>) -> Self
pub fn s3_bucket_name(self, input: impl Into<String>) -> Self
The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.
Sourcepub fn set_s3_bucket_name(self, input: Option<String>) -> Self
pub fn set_s3_bucket_name(self, input: Option<String>) -> Self
The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.
Sourcepub fn get_s3_bucket_name(&self) -> &Option<String>
pub fn get_s3_bucket_name(&self) -> &Option<String>
The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.
Sourcepub fn metrics_configuration(self, input: MetricsConfiguration) -> Self
pub fn metrics_configuration(self, input: MetricsConfiguration) -> Self
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
Sourcepub fn set_metrics_configuration(
self,
input: Option<MetricsConfiguration>,
) -> Self
pub fn set_metrics_configuration( self, input: Option<MetricsConfiguration>, ) -> Self
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
Sourcepub fn get_metrics_configuration(&self) -> &Option<MetricsConfiguration>
pub fn get_metrics_configuration(&self) -> &Option<MetricsConfiguration>
An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
Sourcepub fn flow_actions_role_arn(self, input: impl Into<String>) -> Self
pub fn flow_actions_role_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.
Sourcepub fn set_flow_actions_role_arn(self, input: Option<String>) -> Self
pub fn set_flow_actions_role_arn(self, input: Option<String>) -> Self
The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.
Sourcepub fn get_flow_actions_role_arn(&self) -> &Option<String>
pub fn get_flow_actions_role_arn(&self) -> &Option<String>
The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.
Trait Implementations§
Source§impl Clone for CreateSystemInstanceFluentBuilder
impl Clone for CreateSystemInstanceFluentBuilder
Source§fn clone(&self) -> CreateSystemInstanceFluentBuilder
fn clone(&self) -> CreateSystemInstanceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateSystemInstanceFluentBuilder
impl !RefUnwindSafe for CreateSystemInstanceFluentBuilder
impl Send for CreateSystemInstanceFluentBuilder
impl Sync for CreateSystemInstanceFluentBuilder
impl Unpin for CreateSystemInstanceFluentBuilder
impl !UnwindSafe for CreateSystemInstanceFluentBuilder
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);