Struct CreateSystemInstanceInput

#[non_exhaustive]
pub struct CreateSystemInstanceInput {
    pub tags: Option<Vec<Tag>>,
    pub definition: Option<DefinitionDocument>,
    pub target: Option<DeploymentTarget>,
    pub greengrass_group_name: Option<String>,
    pub s3_bucket_name: Option<String>,
    pub metrics_configuration: Option<MetricsConfiguration>,
    pub flow_actions_role_arn: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tags: Option<Vec<Tag>>

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

definition: Option<DefinitionDocument>

A document that defines an entity.

target: Option<DeploymentTarget>

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

greengrass_group_name: 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.

s3_bucket_name: 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.

metrics_configuration: Option<MetricsConfiguration>

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

flow_actions_role_arn: 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.

Implementations

impl CreateSystemInstanceInput

pub fn tags(&self) -> &[Tag]

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

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().

pub fn definition(&self) -> Option<&DefinitionDocument>

A document that defines an entity.

pub fn target(&self) -> Option<&DeploymentTarget>

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

pub fn greengrass_group_name(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&MetricsConfiguration>

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) -> Option<&str>

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.

impl CreateSystemInstanceInput

pub fn builder() -> CreateSystemInstanceInputBuilder

Creates a new builder-style object to manufacture CreateSystemInstanceInput.

Trait Implementations

impl Clone for CreateSystemInstanceInput

fn clone(&self) -> CreateSystemInstanceInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSystemInstanceInput

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

Formats the value using the given formatter.

impl PartialEq for CreateSystemInstanceInput

fn eq(&self, other: &CreateSystemInstanceInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateSystemInstanceInput