appTemplateBody

A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

The appTemplateBody JSON string has the following structure:

  • **resources**The list of logical resources that must be included in the Resilience Hub application.Type: ArrayDon't add the resources that you want to exclude.Each resources array item includes the following fields:

    • *logicalResourceId*Logical identifier of the resource.Type: ObjectEach logicalResourceId object includes the following fields:

      • identifierIdentifier of the resource.Type: String

      • logicalStackNameThe name of the CloudFormation stack this resource belongs to.Type: String

      • resourceGroupNameThe name of the resource group this resource belongs to.Type: String

      • terraformSourceNameThe name of the Terraform S3 state file this resource belongs to.Type: String

      • eksSourceNameName of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.This parameter accepts values in "eks-cluster/namespace" format.Type: String

    • *type*The type of resource.Type: string

    • *name*The name of the resource.Type: String

    • additionalInfoAdditional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: "failover-regions"Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

  • **appComponents**List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.Type: ArrayEach appComponents array item includes the following fields:

    • nameName of the Application Component.Type: String

    • typeType of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.Type: String

    • resourceNamesThe list of included resources that are assigned to the Application Component.Type: Array of strings

    • additionalInfoAdditional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: "failover-regions"Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

  • **excludedResources**The list of logical resource identifiers to be excluded from the application.Type: ArrayDon't add the resources that you want to include.Each excludedResources array item includes the following fields:

    • *logicalResourceIds*Logical identifier of the resource.Type: ObjectYou can configure only one of the following fields:

      • logicalStackName

      • resourceGroupName

      • terraformSourceName

      • eksSourceName Each logicalResourceIds object includes the following fields:

    • identifierIdentifier of the resource.Type: String

    • logicalStackNameThe name of the CloudFormation stack this resource belongs to.Type: String

    • resourceGroupNameThe name of the resource group this resource belongs to.Type: String

    • terraformSourceNameThe name of the Terraform S3 state file this resource belongs to.Type: String

    • eksSourceNameName of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.This parameter accepts values in "eks-cluster/namespace" format.Type: String

  • **version**Resilience Hub application version.

  • additionalInfoAdditional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.Key: "failover-regions"Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"