Skip to content

CreateSystemInstanceRequest

Source code in docs_src/capo_iotthingsgraph/types/create_system_instance_request.py
class CreateSystemInstanceRequest(TypedDict, closed=True):
    tags: NotRequired["capo_iotthingsgraph.types.tag_list.TagList"]
    """<p>Metadata, consisting of key-value pairs, that can be used to categorize your system instances.</p>"""
    definition: "capo_iotthingsgraph.types.definition_document.DefinitionDocument"
    target: "capo_iotthingsgraph.types.deployment_target.DeploymentTarget"
    """<p>The target type of the deployment. Valid values are <code>GREENGRASS</code> and <code>CLOUD</code>.</p>"""
    greengrass_group_name: NotRequired["capo_iotthingsgraph.types.group_name.GroupName"]
    """<p>The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the <code>target</code> parameter is <code>GREENGRASS</code>.</p>"""
    s3_bucket_name: NotRequired["capo_iotthingsgraph.types.s3_bucket_name.S3BucketName"]
    """<p>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 <code>target</code> parameter is <code>GREENGRASS</code>.</p>"""
    metrics_configuration: NotRequired[
        "capo_iotthingsgraph.types.metrics_configuration.MetricsConfiguration"
    ]
    flow_actions_role_arn: NotRequired["capo_iotthingsgraph.types.role_arn.RoleArn"]
    """<p>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 <code>target</code> parameter is <code>CLOUD</code>.</p>"""

definition instance-attribute

definition: DefinitionDocument

flow_actions_role_arn instance-attribute

flow_actions_role_arn: NotRequired[RoleArn]

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.

greengrass_group_name instance-attribute

greengrass_group_name: NotRequired[GroupName]

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.

metrics_configuration instance-attribute

metrics_configuration: NotRequired[MetricsConfiguration]

s3_bucket_name instance-attribute

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

tags instance-attribute

tags: NotRequired[TagList]

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

target instance-attribute

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