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.Eachresources
array item includes the following fields:*
logicalResourceId
*Logical identifier of the resource.Type: ObjectEachlogicalResourceId
object includes the following fields:identifier
Identifier of the resource.Type: StringlogicalStackName
The name of the CloudFormation stack this resource belongs to.Type: StringresourceGroupName
The name of the resource group this resource belongs to.Type: StringterraformSourceName
The name of the Terraform S3 state file this resource belongs to.Type: StringeksSourceName
Name 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: StringadditionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implementadditionalInfo
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: ArrayEachappComponents
array item includes the following fields:name
Name of the Application Component.Type: Stringtype
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.Type: StringresourceNames
The list of included resources that are assigned to the Application Component.Type: Array of stringsadditionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implementadditionalInfo
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.EachexcludedResources
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
EachlogicalResourceIds
object includes the following fields:identifier
Identifier of the resource.Type: StringlogicalStackName
The name of the CloudFormation stack this resource belongs to.Type: StringresourceGroupName
The name of the resource group this resource belongs to.Type: StringterraformSourceName
The name of the Terraform S3 state file this resource belongs to.Type: StringeksSourceName
Name 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.additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implementadditionalInfo
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>"}]}]"