AWS::IoTFleetHub::Application

Represents a Fleet Hub for AWS IoT Device Management web application.

Syntax

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

JSON

{
  "Type" : "AWS::IoTFleetHub::Application",
  "Properties" : {
      "ApplicationDescription" : String,
      "ApplicationName" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTFleetHub::Application
Properties:
  ApplicationDescription: String
  ApplicationName: String
  RoleArn: String
  Tags: 
    - Tag

Properties

ApplicationDescription

An optional description of the web application.

Required: No

Type: String

Pattern: ^[ -~]*$

Minimum: 1

Maximum: 2048

Update requires: No interruption

ApplicationName

The name of the web application.

Required: Yes

Type: String

Pattern: ^[ -~]*$

Minimum: 1

Maximum: 256

Update requires: No interruption

RoleArn

The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

Note

The name of the role must be in the form FleetHub_random_string.

Pattern: ^arn:[!-~]+$

Required: Yes

Type: String

Pattern: ^arn:[!-~]+$

Minimum: 1

Maximum: 1600

Update requires: No interruption

Tags

A set of key/value pairs that you can use to manage the web application resource.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application ID.

For more information about using the Ref function, see Ref.

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.

ApplicationArn

The ARN of the web application.

ApplicationCreationDate

The date (in Unix epoch time) when the web application was created.

ApplicationId

The unique Id of the web application.

ApplicationLastUpdateDate

The date (in Unix epoch time) when the web application was last updated.

ApplicationState

The current state of the web application.

ApplicationUrl

The URL of the web application.

ErrorMessage

A message that explains any failures included in the applicationState response field. This message explains failures in the CreateApplication and DeleteApplication actions.

SsoClientId

The Id of the single sign-on client that you use to authenticate and authorize users on the web application.