Updates the resource details in the Resilience Hub application¶
Description¶
Updates the resource details in the Resilience Hub application.
- This action has no effect outside Resilience Hub.
- This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the
publish_app_versionAPI. - To update application version with new
physicalResourceID, you must callresolve_app_version_resourcesAPI.
Usage¶
resiliencehub_update_app_version_resource(additionalInfo, appArn,
appComponents, awsAccountId, awsRegion, excluded, logicalResourceId,
physicalResourceId, resourceName, resourceType)
Arguments¶
-
additionalInfoCurrently, there is no supported additional information for resources.
-
appArn[required] 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. -
appComponentsList of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
-
awsAccountIdAmazon Web Services account that owns the physical resource.
-
awsRegionAmazon Web Services region that owns the physical resource.
-
excludedIndicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
-
logicalResourceIdLogical identifier of the resource.
-
physicalResourceIdPhysical identifier of the resource.
-
resourceNameName of the resource.
-
resourceTypeType of resource.
Value¶
A list with the following syntax:
list(
appArn = "string",
appVersion = "string",
physicalResource = list(
additionalInfo = list(
list(
"string"
)
),
appComponents = list(
list(
additionalInfo = list(
list(
"string"
)
),
id = "string",
name = "string",
type = "string"
)
),
excluded = TRUE|FALSE,
logicalResourceId = list(
eksSourceName = "string",
identifier = "string",
logicalStackName = "string",
resourceGroupName = "string",
terraformSourceName = "string"
),
parentResourceName = "string",
physicalResourceId = list(
awsAccountId = "string",
awsRegion = "string",
identifier = "string",
type = "Arn"|"Native"
),
resourceName = "string",
resourceType = "string",
sourceType = "AppTemplate"|"Discovered"
)
)
Request syntax¶
svc$update_app_version_resource(
additionalInfo = list(
list(
"string"
)
),
appArn = "string",
appComponents = list(
"string"
),
awsAccountId = "string",
awsRegion = "string",
excluded = TRUE|FALSE,
logicalResourceId = list(
eksSourceName = "string",
identifier = "string",
logicalStackName = "string",
resourceGroupName = "string",
terraformSourceName = "string"
),
physicalResourceId = "string",
resourceName = "string",
resourceType = "string"
)