System
Represents a system in Resilience Hub. A system is a logical grouping of services.
Contents
- name
-
Resource name (used in ARN — no spaces allowed).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 60.
Pattern:
[A-Za-z0-9][A-Za-z0-9_\-]{1,59}Required: Yes
- systemArn
-
ARN identifier.
Type: String
Length Constraints: Minimum length of 31.
Pattern:
arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}Required: Yes
- systemId
-
System ID for cross-account use without exposing account structure.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
\S{1,255}Required: Yes
- createdAt
-
The timestamp when the system was created.
Type: Timestamp
Required: No
- description
-
Resource description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
- kmsKeyId
-
KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- organizationId
-
The AWS Organizations identifier for the system.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 34.
Pattern:
o-[a-z0-9]{10,32}Required: No
- ouId
-
The organizational unit (OU) identifier for the system.
Type: String
Length Constraints: Minimum length of 16. Maximum length of 68.
Pattern:
ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}Required: No
- sharingEnabled
-
Indicates whether cross-account sharing is enabled.
Type: Boolean
Required: No
-
Resource tags.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[^\x00-\x1f\x22]+Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[^\x00-\x1f\x22]*Required: No
- updatedAt
-
The timestamp when the system was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: