Class: Aws::ResilienceHub::Types::PutDraftAppVersionTemplateRequest

Inherits:

Struct

Object
Struct
Aws::ResilienceHub::Types::PutDraftAppVersionTemplateRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-resiliencehub/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#app_arn ⇒ String

Amazon Resource Name (ARN) of the Resilience Hub application.
#app_template_body ⇒ String

A JSON string that provides information about your application structure.

Instance Attribute Details

#app_arn ⇒ `String`

Amazon Resource Name (ARN) of the 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 *Amazon Web Services General Reference* guide.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

(String)

# File 'lib/aws-sdk-resiliencehub/types.rb', line 5224

class PutDraftAppVersionTemplateRequest < Struct.new(
  :app_arn,
  :app_template_body)
  SENSITIVE = []
  include Aws::Structure
end

#app_template_body ⇒ `String`

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: Array

<note markdown=“1”> Don’t add the resources that you want to exclude.
```
</note>
```
Each ‘resources` array item includes the following fields:
- logicalResourceId
  
  Logical identifier of the resource.
  
  Type: Object
  
  Each ‘logicalResourceId` object includes the following fields:
  - ‘identifier`
    
    Identifier of the resource.
    
    Type: String
  - ‘logicalStackName`
    
    The name of the CloudFormation stack this resource belongs to.
    
    Type: String
  - ‘resourceGroupName`
    
    The name of the resource group this resource belongs to.
    
    Type: String
  - ‘terraformSourceName`
    
    The name of the Terraform S3 state file this resource belongs to.
    
    Type: String
  - ‘eksSourceName`
    
    Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
    
    <note markdown=“1”> This parameter accepts values in “eks-cluster/namespace” format.
```
</note>
```
    Type: String
- type
  
  The type of resource.
  
  Type: string
- name
  
  The name of the resource.
  
  Type: String
- ‘additionalInfo`
  
  Additional 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].
  
  <note markdown=“1”> 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”:}]“‘
```
</note>
```
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: Array

Each ‘appComponents` array item includes the following fields:
- ‘name`
  
  Name of the Application Component.
  
  Type: String
- ‘type`
  
  Type of Application Component. For more information about the types of Application Component, see [Grouping resources in an AppComponent].
  
  Type: String
- ‘resourceNames`
  
  The list of included resources that are assigned to the Application Component.
  
  Type: Array of strings
- ‘additionalInfo`
  
  Additional 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].
  
  <note markdown=“1”> 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”:}]“‘
```
</note>
```
excludedResources

The list of logical resource identifiers to be excluded from the application.

Type: Array

<note markdown=“1”> Don’t add the resources that you want to include.
```
</note>
```
Each ‘excludedResources` array item includes the following fields:
- logicalResourceIds
  
  Logical identifier of the resource.
  
  Type: Object
  
  <note markdown=“1”> You can configure only one of the following fields:
```
* `logicalStackName`
```
  - ‘resourceGroupName`
  - ‘terraformSourceName`
  - ‘eksSourceName`
```
</note>
```
  Each ‘logicalResourceIds` object includes the following fields:
  - ‘identifier`
    
    Identifier of the resource.
    
    Type: String
  - ‘logicalStackName`
    
    The name of the CloudFormation stack this resource belongs to.
    
    Type: String
  - ‘resourceGroupName`
    
    The name of the resource group this resource belongs to.
    
    Type: String
  - ‘terraformSourceName`
    
    The name of the Terraform S3 state file this resource belongs to.
    
    Type: String
  - ‘eksSourceName`
    
    Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
    
    <note markdown=“1”> This parameter accepts values in “eks-cluster/namespace” format.
```
</note>
```
    Type: String
version

Resilience Hub application version.
‘additionalInfo`

Additional 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].

<note markdown=“1”> 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”:}]“‘
```
</note>
```

[1]: docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html [2]: docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html