Struct aws_sdk_iotthingsgraph::client::fluent_builders::CreateSystemInstance

pub struct CreateSystemInstance { /* private fields */ }

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

impl CreateSystemInstance

pub async fn send(
    self
) -> Result<CreateSystemInstanceOutput, SdkError<CreateSystemInstanceError>>

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.

pub fn tags(self, input: Tag) -> Self

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

pub fn definition(self, input: DefinitionDocument) -> Self

A document that defines an entity.

pub fn set_definition(self, input: Option<DefinitionDocument>) -> Self

A document that defines an entity.

pub fn target(self, input: DeploymentTarget) -> Self

The target type of the deployment. Valid values are GREENGRASS and CLOUD.

pub fn set_target(self, input: Option<DeploymentTarget>) -> Self

The target type of the deployment. Valid values are GREENGRASS and CLOUD.

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.

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.

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.

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.

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.

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.

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.

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.

Trait Implementations

impl Clone for CreateSystemInstance

fn clone(&self) -> CreateSystemInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSystemInstance

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

Formats the value using the given formatter.