AWS::Panorama::ApplicationInstance

Creates an application instance and deploys it to a device.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Panorama::ApplicationInstance",
  "Properties" : {
      "ApplicationInstanceIdToReplace" : String,
      "DefaultRuntimeContextDevice" : String,
      "Description" : String,
      "DeviceId" : String,
      "ManifestOverridesPayload" : ManifestOverridesPayload,
      "ManifestPayload" : ManifestPayload,
      "Name" : String,
      "RuntimeRoleArn" : String,
      "StatusFilter" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Panorama::ApplicationInstance
Properties: 
  ApplicationInstanceIdToReplace: String
  DefaultRuntimeContextDevice: String
  Description: String
  DeviceId: String
  ManifestOverridesPayload: 
    ManifestOverridesPayload
  ManifestPayload: 
    ManifestPayload
  Name: String
  RuntimeRoleArn: String
  StatusFilter: String
  Tags: 
    - Tag

Properties

ApplicationInstanceIdToReplace

The ID of an application instance to replace with the new instance.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: [a-zA-Z0-9\-\_]+

Update requires: Replacement

DefaultRuntimeContextDevice

The device's ID.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Pattern: [a-zA-Z0-9\-\_]+

Update requires: Replacement

Description

A description for the application instance.

Required: No

Type: String

Minimum: 0

Maximum: 255

Pattern: .*

Update requires: Replacement

DeviceId

A device's ID.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: [a-zA-Z0-9\-\_]+

Update requires: No interruption

ManifestOverridesPayload

Setting overrides for the application manifest.

Required: No

Type: ManifestOverridesPayload

Update requires: Replacement

ManifestPayload

The application's manifest document.

Required: Yes

Type: ManifestPayload

Update requires: Replacement

Name

A name for the application instance.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: [a-zA-Z0-9\-\_]+

Update requires: Replacement

RuntimeRoleArn

The ARN of a runtime role for the application instance.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+

Update requires: Replacement

StatusFilter

Only include instances with a specific status.

Required: No

Type: String

Allowed values: DEPLOYMENT_ERROR | DEPLOYMENT_FAILED | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED

Update requires: No interruption

Tags

Tags for the application instance.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a unique identifier for this resource.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ApplicationInstanceId

The application instance's ID.

Arn

The application instance's ARN.

CreatedTime

The application instance's created time.

DefaultRuntimeContextDeviceName

The application instance's default runtime context device name.

HealthStatus

The application instance's health status.

LastUpdatedTime

The application instance's last updated time.

Status

The application instance's status.

StatusDescription

The application instance's status description.