String appArn
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.
List<E> resourceMappings
Mappings used to map logical resources from the template to physical resources. You can use the mapping type
CFN_STACK if the application template uses a logical stack name. Or you can map individual resources
by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if
the application is backed by a CloudFormation stack.
String appArn
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.
String appVersion
The version of the application.
List<E> resourceMappings
List of sources that are used to map a logical resource from the template to a physical resource. You can use sources such as CloudFormation, Terraform state files, AppRegistry applications, or Amazon EKS.
String appComponentName
Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the
appComponentNames list.
List<E> appComponentNames
List of Application Component names for the CloudWatch alarm recommendation.
String description
Description of the alarm recommendation.
List<E> items
List of CloudWatch alarm recommendations.
String name
Name of the alarm recommendation.
String prerequisite
The prerequisite for the alarm recommendation.
String recommendationId
Identifier of the alarm recommendation.
String recommendationStatus
Status of the recommended Amazon CloudWatch alarm.
String referenceId
Reference identifier of the alarm recommendation.
String type
Type of alarm recommendation.
String appArn
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.
String assessmentSchedule
Assessment execution schedule with 'Daily' or 'Disabled' values.
String complianceStatus
Current status of compliance for the resiliency policy.
Date creationTime
Date and time when the app was created.
String description
Optional description for an application.
String driftStatus
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
List<E> eventSubscriptions
The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
Date lastAppComplianceEvaluationTime
Date and time the most recent compliance evaluation.
Date lastDriftEvaluationTime
Indicates the last time that a drift was evaluated.
Date lastResiliencyScoreEvaluationTime
Date and time the most recent resiliency score evaluation.
String name
Name for the application.
PermissionModel permissionModel
Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Double resiliencyScore
Current resiliency score for the application.
Integer rpoInSecs
Recovery Point Objective (RPO) in seconds.
Integer rtoInSecs
Recovery Time Objective (RTO) in seconds.
String status
Status of the application.
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
String appArn
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.
String appVersion
Version of an application.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String assessmentName
Name of the assessment.
String assessmentStatus
Current status of the assessment for the resiliency policy.
Map<K,V> compliance
Application compliance against the resiliency policy.
String complianceStatus
Current status of the compliance for the resiliency policy.
Cost cost
Cost for the application.
String driftStatus
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
Date endTime
End time for the action.
String invoker
The entity that invoked the assessment.
String message
Error or warning message from the assessment execution
ResiliencyPolicy policy
Resiliency policy of an application.
ResiliencyScore resiliencyScore
Current resiliency score for an application.
ResourceErrorsDetails resourceErrorsDetails
A resource error object containing a list of errors retrieving an application's resources.
Date startTime
Starting time for the action.
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
String versionName
Version name of the published application.
String appArn
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.
String appVersion
Version of an application.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String assessmentName
Name of the assessment.
String assessmentStatus
Current status of the assessment for the resiliency policy.
String complianceStatus
TCurrent status of compliance for the resiliency policy.
Cost cost
Cost for an application.
String driftStatus
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
Date endTime
End time for the action.
String invoker
Entity that invoked the assessment.
String message
Message from the assessment run.
Double resiliencyScore
Current resiliency score for the application.
Date startTime
Starting time for the action.
String versionName
Name of an application version.
Map<K,V> 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.
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>"}]}]"
String id
Identifier of the Application Component.
String name
Name of the Application Component.
String type
The type of Application Component.
String appComponentName
Name of the Application Component.
Map<K,V> compliance
The compliance of the Application Component against the resiliency policy.
Cost cost
The cost for the application.
String message
The compliance message.
ResiliencyScore resiliencyScore
The current resiliency score for the application.
String status
Status of the action.
EksSourceClusterNamespace eksSourceClusterNamespace
The namespace on your Amazon Elastic Kubernetes Service cluster.
String importType
The resource type of the input source.
Integer resourceCount
The number of resources.
String sourceArn
The Amazon Resource Name (ARN) of the input source. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String sourceName
The name of the input source.
TerraformSource terraformSource
The name of the Terraform s3 state file.
String appArn
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.
String assessmentSchedule
Assessment execution schedule with 'Daily' or 'Disabled' values.
String complianceStatus
The current status of compliance for the resiliency policy.
Date creationTime
Date and time when the app was created.
String description
The optional description for an app.
String driftStatus
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
Date lastAppComplianceEvaluationTime
Date and time of the most recent compliance evaluation.
String name
The name of the application.
Double resiliencyScore
The current resiliency score for the application.
Integer rpoInSecs
Recovery Point Objective (RPO) in seconds.
Integer rtoInSecs
Recovery Time Objective (RTO) in seconds.
String status
Status of the application.
String appArn
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.
List<E> requestEntries
Defines the list of operational recommendations that need to be included or excluded.
String appArn
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.
List<E> failedEntries
A list of items with error details about each item, which could not be included or excluded.
List<E> successfulEntries
A list of items that were included or excluded.
String entryId
An identifier for an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
String excludeReason
Indicates the reason for excluding an operational recommendation.
Boolean excluded
Indicates if the operational recommendation was successfully excluded.
UpdateRecommendationStatusItem item
The operational recommendation item.
String referenceId
Reference identifier of the operational recommendation.
String actualReferenceId
Assessment identifier that is associated with this drift item.
Map<K,V> actualValue
Actual compliance value of the entity.
String appId
Identifier of your application.
String appVersion
Published version of your application on which drift was detected.
String diffType
Difference type between actual and expected recovery point objective (RPO) and recovery time objective (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.
String driftType
The type of drift detected. Currently, Resilience Hub supports only ApplicationCompliance drift type.
String entityId
Identifier of an entity in which drift was detected. For compliance drift, the entity ID can be either application ID or the AppComponent ID.
String entityType
The type of entity in which drift was detected. For compliance drifts, Resilience Hub supports
AWS::ResilienceHub::AppComponent and AWS::ResilienceHub::Application.
String expectedReferenceId
Assessment identifier of a previous assessment of the same application version. Resilience Hub uses the previous assessment (associated with the reference identifier) to compare the compliance with the current assessment to identify drifts.
Map<K,V> expectedValue
The expected compliance value of an entity.
String appComponentName
Name of the Application Component.
Map<K,V> compliance
The current compliance against the resiliency policy before applying the configuration change.
Cost cost
The cost for the application.
String description
The optional description for an app.
String haArchitecture
The architecture type.
String name
The name of the recommendation configuration.
String optimizationType
The type of optimization.
Map<K,V> recommendationCompliance
The expected compliance against the resiliency policy after applying the configuration change.
String referenceId
Reference identifier for the recommendation configuration.
List<E> suggestedChanges
List of the suggested configuration changes.
String assessmentSchedule
Assessment execution schedule with 'Daily' or 'Disabled' values.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String description
The optional description for an app.
List<E> eventSubscriptions
The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.
String name
Name of the application.
PermissionModel permissionModel
Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
App app
The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.
Map<K,V> additionalInfo
Currently, there is no supported additional information for Application Components.
String appArn
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.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String id
Identifier of the Application Component.
String name
Name of the Application Component.
String type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
String appArn
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.
AppComponent appComponent
List of Application Components that belong to this resource.
String appVersion
Resilience Hub application version.
Map<K,V> additionalInfo
Currently, there is no supported additional information for resources.
String appArn
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.
List<E> 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.
String awsAccountId
Amazon Web Services account that owns the physical resource.
String awsRegion
Amazon Web Services region that owns the physical resource.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
LogicalResourceId logicalResourceId
Logical identifier of the resource.
String physicalResourceId
Physical identifier of the resource.
String resourceName
Name of the resource.
String resourceType
Type of resource.
String appArn
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.
String appVersion
Resilience Hub application version.
PhysicalResource physicalResource
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String bucketName
The name of the Amazon S3 bucket that will contain the recommendation template.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String format
The format for the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
String name
The name for the recommendation template.
List<E> recommendationIds
Identifiers for the recommendations used to create a recommendation template.
List<E> recommendationTypes
An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
RecommendationTemplate recommendationTemplate
The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String dataLocationConstraint
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
Map<K,V> policy
The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
String policyDescription
The description for the policy.
String policyName
The name of the policy
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
String tier
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (
NonCritical).
ResiliencyPolicy policy
The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String assessmentStatus
The current status of the assessment for the resiliency policy.
String appArn
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.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
EksSourceClusterNamespace eksSourceClusterNamespace
The namespace on your Amazon Elastic Kubernetes Service cluster that you want to delete from the Resilience Hub application.
String sourceArn
The Amazon Resource Name (ARN) of the imported resource you want to remove from the Resilience Hub application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
TerraformSource terraformSource
The imported Terraform s3 state file you want to remove from the Resilience Hub application.
String appArn
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.
AppInputSource appInputSource
Name of the input source from where the application resource is imported from.
String appArn
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.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
Boolean forceDelete
A boolean option to force the deletion of an Resilience Hub application.
String appArn
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.
String appArn
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.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String id
Identifier of the Application Component.
String appArn
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.
AppComponent appComponent
List of Application Components that belong to this resource.
String appVersion
Resilience Hub application version.
String appArn
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.
String awsAccountId
Amazon Web Services account that owns the physical resource.
String awsRegion
Amazon Web Services region that owns the physical resource.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
LogicalResourceId logicalResourceId
Logical identifier of the resource.
String physicalResourceId
Physical identifier of the resource.
String resourceName
Name of the resource.
String appArn
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.
String appVersion
Resilience Hub application version.
PhysicalResource physicalResource
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String recommendationTemplateArn
The Amazon Resource Name (ARN) for a recommendation template.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
AppAssessment assessment
The assessment for an Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.
String appArn
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.
App app
The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
String appArn
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.
String appVersion
Resilience Hub application version.
String id
Identifier of the Application Component.
String appArn
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.
AppComponent appComponent
List of Application Components that belong to this resource.
String appVersion
Resilience Hub application version.
String appArn
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.
String appVersion
Resilience Hub application version.
String appArn
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.
String appVersion
Resilience Hub application version.
String awsAccountId
Amazon Web Services account that owns the physical resource.
String awsRegion
Amazon Web Services region that owns the physical resource.
LogicalResourceId logicalResourceId
Logical identifier of the resource.
String physicalResourceId
Physical identifier of the resource.
String resourceName
Name of the resource.
String appArn
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.
String appVersion
Resilience Hub application version.
PhysicalResource physicalResource
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
String appArn
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.
String appVersion
The version of the application.
String resolutionId
The identifier for a specific resolution.
String appArn
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.
String appVersion
The version of the application.
String errorMessage
The returned error message for the request.
String resolutionId
The identifier for a specific resolution.
String status
Status of the action.
Map<K,V> 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.
Currently, this parameter supports only failover region and account.
String appArn
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.
String appVersion
Resilience Hub application version.
String appArn
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.
String appVersion
The version of the application.
String appArn
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.
String 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: Array
Don't add the resources that you want to exclude.
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.
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
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.
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: 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.
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: Array
Don't add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
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.
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 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>"}]}]"
String appVersion
The version of the application.
String appArn
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.
String appArn
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.
String appVersion
The version of the application.
String errorMessage
The returned error message for the request.
String status
Status of the action.
Date statusChangeTime
The time when the status last changed.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
ResiliencyPolicy policy
Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.
Integer achievableRpoInSecs
The Recovery Point Objective (RPO) that is achievable, in seconds.
Integer achievableRtoInSecs
The Recovery Time Objective (RTO) that is achievable, in seconds
String complianceStatus
The current status of compliance for the resiliency policy.
Integer currentRpoInSecs
The current RPO, in seconds.
Integer currentRtoInSecs
The current RTO, in seconds.
String message
The disruption compliance message.
String rpoDescription
The RPO description.
String rpoReferenceId
Reference identifier of the RPO .
String rtoDescription
The RTO description.
String rtoReferenceId
Reference identifier of the RTO.
String eksClusterArn
Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:
aws:eks:region:account-id:cluster/cluster-name. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
List<E> namespaces
The list of namespaces located on your Amazon Elastic Kubernetes Service cluster.
String eksClusterArn
Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: arn:
aws:eks:region:account-id:cluster/cluster-name. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String namespace
Name of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.
String eventType
The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports
notifications only for Drift detected (DriftDetected) and Scheduled assessment failure
(ScheduledAssessmentFailure) events.
String name
Unique name to identify an event subscription.
String snsTopicArn
Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is:
arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names
(ARNs) in the Amazon Web Services General Reference guide.
String appArn
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.
List<E> eksSources
The input sources of the Amazon Elastic Kubernetes Service resources you need to import.
String importStrategy
The import strategy you would like to set to import resources into Resilience Hub application.
List<E> sourceArns
The Amazon Resource Names (ARNs) for the resources.
List<E> terraformSources
A list of terraform file s3 URLs you need to import.
String appArn
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.
String appVersion
The version of the application.
List<E> eksSources
The input sources of the Amazon Elastic Kubernetes Service resources you have imported.
List<E> sourceArns
The Amazon Resource Names (ARNs) for the resources you have imported.
String status
Status of the action.
List<E> terraformSources
A list of terraform file s3 URLs you have imported.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
List<E> alarmRecommendations
The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.
String nextToken
Token for the next set of results, or null if there are no more results.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Indicates the maximum number of applications requested.
String nextToken
Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
List<E> complianceDrifts
Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.
String nextToken
Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Indicates the maximum number of drift results to include in the response. If more results exist than the
specified MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String appArn
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.
String assessmentName
The name for the assessment.
List<E> assessmentStatus
The current status of the assessment for the resiliency policy.
String complianceStatus
The current status of compliance for the resiliency policy.
String invoker
Specifies the entity that invoked a specific assessment, either a User or the System.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
Boolean reverseOrder
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to
true.
List<E> assessmentSummaries
The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.
String nextToken
Token for the next set of results, or null if there are no more results.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
List<E> componentCompliances
The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.
String nextToken
Token for the next set of results, or null if there are no more results.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
List<E> componentRecommendations
The recommendations for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.
String nextToken
Token for the next set of results, or null if there are no more results.
String appArn
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.
String appVersion
Resilience Hub application version.
Integer maxResults
Maximum number of input sources to be displayed per Resilience Hub application.
String nextToken
Null, or the token from a previous call to get the next set of results.
String appArn
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.
Date fromLastAssessmentTime
Indicates the lower limit of the range that is used to filter applications based on their last assessment times.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String name
The name for the one of the listed applications.
String nextToken
Null, or the token from a previous call to get the next set of results.
Boolean reverseOrder
The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By
default, application list is sorted in ascending order. To sort the appliation list in descending order, set this
field to True.
Date toLastAssessmentTime
Indicates the upper limit of the range that is used to filter the applications based on their last assessment times.
String appArn
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.
String appVersion
Version of the Application Component.
Integer maxResults
Maximum number of Application Components to be displayed per Resilience Hub application version.
String nextToken
Null, or the token from a previous call to get the next set of results.
String appArn
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.
List<E> appComponents
Defines an Application Component.
String appVersion
Resilience Hub application version.
String nextToken
Token for the next set of results, or null if there are no more results.
String appArn
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.
String appVersion
The version of the application.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String nextToken
Token for the next set of results, or null if there are no more results.
List<E> resourceMappings
Mappings used to map logical resources from the template to physical resources. You can use the mapping type
CFN_STACK if the application template uses a logical stack name. Or you can map individual resources
by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if
the application is backed by a CloudFormation stack.
String appArn
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.
String appVersion
The version of the application.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String resolutionId
The identifier for a specific resolution.
String appArn
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.
Date endTime
Upper limit of the time range to filter the application versions.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
Date startTime
Lower limit of the time range to filter the application versions.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String name
The name for one of the listed recommendation templates.
String nextToken
Null, or the token from a previous call to get the next set of results.
String recommendationTemplateArn
The Amazon Resource Name (ARN) for a recommendation template.
Boolean reverseOrder
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to
true.
List<E> status
Status of the action.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String policyName
The name of the policy
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String resourceArn
The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String appArn
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.
String appVersion
The version of the application.
Integer maxResults
Maximum number of results to include in the response. If more results exist than the specified
MaxResults value, a token is included in the response so that the remaining results can be
retrieved.
String nextToken
Null, or the token from a previous call to get the next set of results.
String resolutionId
The identifier for a specific resolution.
String eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
String identifier
Identifier of the resource.
String logicalStackName
The name of the CloudFormation stack this resource belongs to.
String resourceGroupName
The name of the resource group that this resource belongs to.
String terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
List<E> crossAccountRoleArns
Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.
These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the
primary account.
String invokerRoleName
Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.
You must have iam:passRole permission for this role while creating or updating the application.
Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
String type
Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.
Map<K,V> 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.
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>"}]}]"
List<E> appComponents
The application components that belong to this resource.
Boolean excluded
Indicates if a resource is included or excluded from the assessment.
LogicalResourceId logicalResourceId
Logical identifier of the resource.
String parentResourceName
Name of the parent resource.
PhysicalResourceId physicalResourceId
Identifier of the physical resource.
String resourceName
The name of the resource.
String resourceType
Type of resource.
String sourceType
Type of input source.
String awsAccountId
The Amazon Web Services account that owns the physical resource.
String awsRegion
The Amazon Web Services Region that the physical resource is located in.
String identifier
Identifier of the physical resource.
String type
Specifies the type of physical resource identifier.
The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:
AWS::ECS::Service
AWS::EFS::FileSystem
AWS::ElasticLoadBalancingV2::LoadBalancer
AWS::Lambda::Function
AWS::SNS::Topic
The resource identifier is an Resilience Hub-native identifier and it can identify the following list of resources:
AWS::ApiGateway::RestApi
AWS::ApiGatewayV2::Api
AWS::AutoScaling::AutoScalingGroup
AWS::DocDB::DBCluster
AWS::DocDB::DBGlobalCluster
AWS::DocDB::DBInstance
AWS::DynamoDB::GlobalTable
AWS::DynamoDB::Table
AWS::EC2::EC2Fleet
AWS::EC2::Instance
AWS::EC2::NatGateway
AWS::EC2::Volume
AWS::ElasticLoadBalancing::LoadBalancer
AWS::RDS::DBCluster
AWS::RDS::DBInstance
AWS::RDS::GlobalCluster
AWS::Route53::RecordSet
AWS::S3::Bucket
AWS::SQS::Queue
String appArn
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.
String versionName
Name of the application version.
String appArn
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.
String appVersion
The version of the application.
Long identifier
Identifier of the application version.
String versionName
Name of the application version.
String appArn
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.
String 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: Array
Don't add the resources that you want to exclude.
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.
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
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.
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: 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.
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: Array
Don't add the resources that you want to include.
Each excludedResources array item includes the following fields:
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
logicalStackName
resourceGroupName
terraformSourceName
eksSourceName
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.
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 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>"}]}]"
String appArn
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.
String appVersion
The version of the application.
String expectedComplianceStatus
The expected compliance status after applying the recommended configuration change.
String expectedRpoDescription
The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.
Integer expectedRpoInSecs
The expected RPO after applying the recommended configuration change.
String expectedRtoDescription
The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.
Integer expectedRtoInSecs
The expected RTO after applying the recommended configuration change.
Boolean alreadyImplemented
Specifies if the recommendation has already been implemented.
String excludeReason
Indicates the reason for excluding an operational recommendation.
Boolean excluded
Indicates if an operational recommendation item is excluded.
String resourceId
Identifier of the resource.
String targetAccountId
Identifier of the target account.
String targetRegion
The target region.
String appArn
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.
String assessmentArn
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition
:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference guide.
Date endTime
The end time for the action.
String format
Format of the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
String message
Message for the recommendation template.
String name
Name for the recommendation template.
Boolean needsReplacements
Indicates if replacements are needed.
List<E> recommendationIds
Identifiers for the recommendations used in the recommendation template.
String recommendationTemplateArn
Amazon Resource Name (ARN) for the recommendation template.
List<E> recommendationTypes
An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
Date startTime
The start time for the action.
String status
Status of the action.
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
S3Location templatesLocation
The file location of the template.
String appArn
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.
List<E> appRegistryAppNames
The names of the registered applications you want to remove from the resource mappings.
List<E> eksSourceNames
The names of the Amazon Elastic Kubernetes Service clusters and namespaces you want to remove from the resource mappings.
This parameter accepts values in "eks-cluster/namespace" format.
List<E> logicalStackNames
The names of the CloudFormation stacks you want to remove from the resource mappings.
List<E> resourceGroupNames
The names of the resource groups you want to remove from the resource mappings.
List<E> resourceNames
The names of the resources you want to remove from the resource mappings.
List<E> terraformSourceNames
The names of the Terraform sources you want to remove from the resource mappings.
String appArn
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.
String appVersion
The version of the application.
Date creationTime
Date and time when the resiliency policy was created.
String dataLocationConstraint
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
String estimatedCostTier
Specifies the estimated cost tier of the resiliency policy.
Map<K,V> policy
The resiliency policy.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String policyDescription
The description for the policy.
String policyName
The name of the policy
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
String tier
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (
NonCritical).
Map<K,V> componentScore
The score generated by Resilience Hub for the scoring component after running an assessment.
For example, if the score is 25 points, it indicates the overall score of your application generated
by Resilience Hub after running an assessment.
Map<K,V> disruptionScore
The disruption score for a valid key.
Double score
The outage score for a valid key.
String appArn
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.
String appVersion
The version of the application.
String appArn
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.
String appVersion
The version of the application.
String resolutionId
The identifier for a specific resolution.
String status
Status of the action.
String appArn
Amazon Resource Name (ARN) of the application whose resources have drifted. The format for this ARN is: arn:
partition:resiliencehub:region:account:app-assessment/app-id.
For more information about ARNs, see Amazon Resource Names
(ARNs) in the Amazon Web Services General Reference guide.
String appVersion
Version of the application whose resources have drifted.
String diffType
Indicates if the resource was added or removed.
String referenceId
Reference identifier of the resource drift.
ResourceIdentifier resourceIdentifier
Identifier of the drifted resource.
LogicalResourceId logicalResourceId
Logical identifier of the drifted resource.
String resourceType
Type of the drifted resource.
String appRegistryAppName
Name of the application this resource is mapped to when the mappingType is
AppRegistryApp.
String eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the
mappingType is EKS.
This parameter accepts values in "eks-cluster/namespace" format.
String logicalStackName
Name of the CloudFormation stack this resource is mapped to when the mappingType is
CfnStack.
String mappingType
Specifies the type of resource mapping.
PhysicalResourceId physicalResourceId
Identifier of the physical resource.
String resourceGroupName
Name of the Resource Groups that this resource is mapped to when the mappingType is
ResourceGroup.
String resourceName
Name of the resource that this resource is mapped to when the mappingType is Resource.
String terraformSourceName
Name of the Terraform source that this resource is mapped to when the mappingType is
Terraform.
Long excludedCount
Number of recommendations that were excluded from the assessment.
For example, if the excludedCount for Alarms coverage scoring component is 7, it indicates that 7
Amazon CloudWatch alarms are excluded from the assessment.
Long outstandingCount
Number of recommendations that must be implemented to obtain the maximum possible score for the scoring component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For compliance, these are the number of Application Components that have breached the resiliency policy.
For example, if the outstandingCount for Alarms coverage scoring component is 5, it indicates that 5
Amazon CloudWatch alarms need to be implemented to achieve the maximum possible score.
Double possibleScore
Maximum possible score that can be obtained for the scoring component.
For example, if the possibleScore is 20 points, it indicates the maximum possible score you can
achieve for the scoring component when you run a new assessment after implementing all the Resilience Hub
recommendations.
Double score
Resiliency score points given for the scoring component. The score is always less than or equal to the
possibleScore.
String appComponentName
Name of the Application Component.
String description
Description of the SOP recommendation.
List<E> items
The recommendation items.
String name
Name of the SOP recommendation.
String prerequisite
Prerequisite for the SOP recommendation.
String recommendationId
Identifier for the SOP recommendation.
String recommendationStatus
Status of the recommended standard operating procedure.
String referenceId
Reference identifier for the SOP recommendation.
String serviceType
The service type.
String appArn
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.
String appVersion
The version of the application.
String assessmentName
The name for the assessment.
String clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
Map<K,V> tags
Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
AppAssessment assessment
The assessment created.
String s3StateFileUrl
The URL of the Terraform s3 state file you need to import.
String appComponentName
Name of the Application Component.
List<E> dependsOnAlarms
A list of recommended alarms that are used in the test and must be exported before or with the test.
String description
Description for the test recommendation.
String intent
Intent of the test recommendation.
List<E> items
The test recommendation items.
String name
Name of the test recommendation.
String prerequisite
Prerequisite of the test recommendation.
String recommendationId
Identifier for the test recommendation.
String recommendationStatus
Status of the recommended test.
String referenceId
Reference identifier for the test recommendation.
String risk
Level of risk for this test recommendation.
String type
Type of test recommendation.
Integer retryAfterSeconds
The number of seconds to wait before retrying the operation.
LogicalResourceId logicalResourceId
Logical resource identifier for the unsupported resource.
PhysicalResourceId physicalResourceId
Physical resource identifier for the unsupported resource.
String resourceType
The type of resource.
String unsupportedResourceStatus
The status of the unsupported resource.
String appArn
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.
String assessmentSchedule
Assessment execution schedule with 'Daily' or 'Disabled' values.
Boolean clearResiliencyPolicyArn
Specifies if the resiliency policy ARN should be cleared.
String description
The optional description for an app.
List<E> eventSubscriptions
The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
PermissionModel permissionModel
Defines the roles and credentials that Resilience Hub would use while creating an application, importing its resources, and running an assessment.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
App app
The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
Map<K,V> additionalInfo
Currently, there is no supported additional information for Application Components.
String appArn
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.
String id
Identifier of the Application Component.
String name
Name of the Application Component.
String type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
String appArn
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.
AppComponent appComponent
List of Application Components that belong to this resource.
String appVersion
Resilience Hub application version.
Map<K,V> 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.
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>"}]}]"
String appArn
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.
Map<K,V> additionalInfo
Currently, there is no supported additional information for resources.
String appArn
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.
List<E> 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.
String awsAccountId
Amazon Web Services account that owns the physical resource.
String awsRegion
Amazon Web Services region that owns the physical resource.
Boolean excluded
Indicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
LogicalResourceId logicalResourceId
Logical identifier of the resource.
String physicalResourceId
Physical identifier of the resource.
String resourceName
Name of the resource.
String resourceType
Type of resource.
String appArn
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.
String appVersion
Resilience Hub application version.
PhysicalResource physicalResource
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
Map<K,V> 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.
Currently, this parameter supports only failover region and account.
String appArn
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.
String appVersion
Resilience Hub application version.
String entryId
An identifier for an entry in this batch that is used to communicate the result.
The entryIds of a batch request need to be unique within a request.
String excludeReason
Indicates the reason for excluding an operational recommendation.
Boolean excluded
Indicates if the operational recommendation needs to be excluded. If set to True, the operational recommendation will be excluded.
UpdateRecommendationStatusItem item
The operational recommendation item.
String referenceId
Reference identifier of the operational recommendation item.
String dataLocationConstraint
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
Map<K,V> policy
The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
String policyArn
Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition
:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
String policyDescription
The description for the policy.
String policyName
The name of the policy
String tier
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (
NonCritical).
ResiliencyPolicy policy
The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
Copyright © 2024. All rights reserved.