DescribeAppVersionTemplateResponse
import type { DescribeAppVersionTemplateResponse } from "https://aws-api.deno.dev/v0.4/services/resiliencehub.ts?docs=full";
interface DescribeAppVersionTemplateResponse {
appArn: string;
appTemplateBody: string;
appVersion: string;
}§Properties
§
appArn: string
[src]The Amazon Resource Name (ARN) of the AWS Resilience Hub application.
The format for this ARN is: arn:partition
:resiliencehub:region
:account
:app/app-id
.
For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
§
appTemplateBody: string
[src]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 needs to be included in the application. Type: Array Note: Don't add the resources that you want to exclude. Eachresources
array item includes the following fields:- _ logicalResourceId_
The logical identifier of the resource.
Type: Object
Each
logicalResourceId
object includes the following fields:-
The identifier of the resource. Type: Stringidentifier
-
The name of the CloudFormation stack this resource belongs to. Type: StringlogicalStackName
-
The name of the resource group this resource belongs to. Type: StringresourceGroupName
-
The name of the Terraform S3 state file this resource belongs to. Type: StringterraformSourceName
-
- _ type_ The type of resource. Type: string
- _ name_ The name of the resource. Type: String
- _ logicalResourceId_
The logical identifier of the resource.
Type: Object
Each
-
appComponents
The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added. Type: Array EachappComponents
array item includes the following fields:-
The name of the Application Component. Type: Stringname
-
The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent. Type: Stringtype
-
The list of included resources that are assigned to the Application Component. Type: Array of stringsresourceNames
-
Additional configuration parameters for an AWS Resilience Hub application. Note: Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account. Key:additionalInfo
"failover-regions"
Value:"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
-
-
excludedResources
The list of logical resource identifiers to be excluded from the application. Type: Array Note: Don't add the resources that you want to include. EachexcludedResources
array item includes the following fields:- _ logicalResourceIds_
The logical identifier of the resource.
Type: Object
Note:
You can configure only one of the following fields:
- logicalStackName
- resourceGroupName
- terraformSourceName
Each
logicalResourceIds
object includes the following fields:-
The identifier of the resource. Type: Stringidentifier
-
The name of the CloudFormation stack this resource belongs to. Type: StringlogicalStackName
-
The name of the resource group this resource belongs to. Type: StringresourceGroupName
-
The name of the Terraform S3 state file this resource belongs to. Type: StringterraformSourceName
-
- _ logicalResourceIds_
The logical identifier of the resource.
Type: Object
Note:
You can configure only one of the following fields:
- logicalStackName
- resourceGroupName
- terraformSourceName
Each