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 an AWS Resilience Hub-native identifier.
Contents
- logicalResourceId
-
Logical identifier of the resource.
Type: LogicalResourceId object
Required: Yes
- physicalResourceId
-
Identifier of the physical resource.
Type: PhysicalResourceId object
Required: Yes
- resourceType
-
Type of resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- additionalInfo
-
Additional configuration parameters for an AWS Resilience Hub application. If you want to implement
additionalInfo
through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Note
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>"}]}]"
Type: String to array of strings map
Key Pattern:
^\S{1,128}$
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- appComponents
-
The application components that belong to this resource.
Type: Array of AppComponent objects
Required: No
- excluded
-
Indicates if a resource is included or excluded from the assessment.
Type: Boolean
Required: No
- parentResourceName
-
Name of the parent resource.
Type: String
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
Required: No
- resourceName
-
The name of the resource.
Type: String
Pattern:
^[A-Za-z0-9][A-Za-z0-9_\-]{1,59}$
Required: No
- sourceType
-
Type of input source.
Type: String
Valid Values:
AppTemplate | Discovered
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: