Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTThingsGraph.CreateSystemInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data CreateSystemInstance Source #

See: newCreateSystemInstance smart constructor.

Constructors

CreateSystemInstance'

Fields

metricsConfiguration :: Maybe MetricsConfiguration
greengrassGroupName :: Maybe Text
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.
flowActionsRoleArn :: Maybe Text
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.
s3BucketName :: Maybe Text
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.
tags :: Maybe [Tag]
Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
definition :: DefinitionDocument
target :: DeploymentTarget
The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Instances

Instances details

Eq CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods (==) :: CreateSystemInstance -> CreateSystemInstance -> Bool # (/=) :: CreateSystemInstance -> CreateSystemInstance -> Bool #
Read CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods readsPrec :: Int -> ReadS CreateSystemInstance # readList :: ReadS [CreateSystemInstance] # readPrec :: ReadPrec CreateSystemInstance # readListPrec :: ReadPrec [CreateSystemInstance] #
Show CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods showsPrec :: Int -> CreateSystemInstance -> ShowS # show :: CreateSystemInstance -> String # showList :: [CreateSystemInstance] -> ShowS #
Generic CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Associated Types type Rep CreateSystemInstance :: Type -> Type # Methods from :: CreateSystemInstance -> Rep CreateSystemInstance x # to :: Rep CreateSystemInstance x -> CreateSystemInstance #
NFData CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods rnf :: CreateSystemInstance -> () #
Hashable CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods hashWithSalt :: Int -> CreateSystemInstance -> Int # hash :: CreateSystemInstance -> Int #
ToJSON CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods toJSON :: CreateSystemInstance -> Value # toEncoding :: CreateSystemInstance -> Encoding # toJSONList :: [CreateSystemInstance] -> Value # toEncodingList :: [CreateSystemInstance] -> Encoding #
AWSRequest CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Associated Types type AWSResponse CreateSystemInstance # Methods request :: CreateSystemInstance -> Request CreateSystemInstance # response :: MonadResource m => Logger -> Service -> Proxy CreateSystemInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSystemInstance))) #
ToHeaders CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods toHeaders :: CreateSystemInstance -> [Header] #
ToPath CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods toPath :: CreateSystemInstance -> ByteString #
ToQuery CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods toQuery :: CreateSystemInstance -> QueryString #
type Rep CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance type Rep CreateSystemInstance = D1 ('MetaData "CreateSystemInstance" "Amazonka.IoTThingsGraph.CreateSystemInstance" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "CreateSystemInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metricsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricsConfiguration)) :: (S1 ('MetaSel ('Just "greengrassGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "flowActionsRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinitionDocument) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentTarget)))))
type AWSResponse CreateSystemInstance Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance type AWSResponse CreateSystemInstance = CreateSystemInstanceResponse

newCreateSystemInstance Source #

Arguments

:: DefinitionDocument	`$sel:definition:CreateSystemInstance'`
-> DeploymentTarget	`$sel:target:CreateSystemInstance'`
-> CreateSystemInstance

Create a value of CreateSystemInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metricsConfiguration:CreateSystemInstance', createSystemInstance_metricsConfiguration - Undocumented member.

$sel:greengrassGroupName:CreateSystemInstance', createSystemInstance_greengrassGroupName - 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.

$sel:flowActionsRoleArn:CreateSystemInstance', createSystemInstance_flowActionsRoleArn - 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.

$sel:s3BucketName:CreateSystemInstance', createSystemInstance_s3BucketName - 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.

$sel:tags:CreateSystemInstance', createSystemInstance_tags - Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

$sel:definition:CreateSystemInstance', createSystemInstance_definition - Undocumented member.

$sel:target:CreateSystemInstance', createSystemInstance_target - The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Request Lenses

createSystemInstance_metricsConfiguration :: Lens' CreateSystemInstance (Maybe MetricsConfiguration) Source #

Undocumented member.

createSystemInstance_greengrassGroupName :: Lens' CreateSystemInstance (Maybe Text) Source #

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.

createSystemInstance_flowActionsRoleArn :: Lens' CreateSystemInstance (Maybe Text) Source #

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.

createSystemInstance_s3BucketName :: Lens' CreateSystemInstance (Maybe Text) Source #

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.

createSystemInstance_tags :: Lens' CreateSystemInstance (Maybe [Tag]) Source #

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

createSystemInstance_definition :: Lens' CreateSystemInstance DefinitionDocument Source #

Undocumented member.

createSystemInstance_target :: Lens' CreateSystemInstance DeploymentTarget Source #

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

Destructuring the Response

data CreateSystemInstanceResponse Source #

See: newCreateSystemInstanceResponse smart constructor.

Constructors

CreateSystemInstanceResponse'
Fields summary :: Maybe SystemInstanceSummary The summary object that describes the new system instance. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateSystemInstanceResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods (==) :: CreateSystemInstanceResponse -> CreateSystemInstanceResponse -> Bool # (/=) :: CreateSystemInstanceResponse -> CreateSystemInstanceResponse -> Bool #
Read CreateSystemInstanceResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods readsPrec :: Int -> ReadS CreateSystemInstanceResponse # readList :: ReadS [CreateSystemInstanceResponse] # readPrec :: ReadPrec CreateSystemInstanceResponse # readListPrec :: ReadPrec [CreateSystemInstanceResponse] #
Show CreateSystemInstanceResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods showsPrec :: Int -> CreateSystemInstanceResponse -> ShowS # show :: CreateSystemInstanceResponse -> String # showList :: [CreateSystemInstanceResponse] -> ShowS #
Generic CreateSystemInstanceResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Associated Types type Rep CreateSystemInstanceResponse :: Type -> Type # Methods from :: CreateSystemInstanceResponse -> Rep CreateSystemInstanceResponse x # to :: Rep CreateSystemInstanceResponse x -> CreateSystemInstanceResponse #
NFData CreateSystemInstanceResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance Methods rnf :: CreateSystemInstanceResponse -> () #
type Rep CreateSystemInstanceResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.CreateSystemInstance type Rep CreateSystemInstanceResponse = D1 ('MetaData "CreateSystemInstanceResponse" "Amazonka.IoTThingsGraph.CreateSystemInstance" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "CreateSystemInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SystemInstanceSummary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSystemInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSystemInstanceResponse'`
-> CreateSystemInstanceResponse

Create a value of CreateSystemInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:summary:CreateSystemInstanceResponse', createSystemInstanceResponse_summary - The summary object that describes the new system instance.

$sel:httpStatus:CreateSystemInstanceResponse', createSystemInstanceResponse_httpStatus - The response's http status code.

Response Lenses

createSystemInstanceResponse_summary :: Lens' CreateSystemInstanceResponse (Maybe SystemInstanceSummary) Source #

The summary object that describes the new system instance.

createSystemInstanceResponse_httpStatus :: Lens' CreateSystemInstanceResponse Int Source #

The response's http status code.