systems

Creates, updates, deletes, gets or lists a systems resource.

Overview

Name	systems
Type	Resource
Id	aws.resiliencehubv2.systems

Fields

The following fields are returned by SELECT queries:

get_system

Name	Datatype	Description
name	string	Resource name (used in ARN — no spaces allowed). (pattern: <code>[A-Za-z0-9][A-Za-z0-9_-]{1,59}</code>)
created_at	string (date-time)	The timestamp when the system was created.
description	string	Resource description.
kms_key_id	string	KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
organization_id	string	The AWS Organizations identifier for the system. (pattern: <code>o-[a-z0-9]{10,32}</code>)
ou_id	string	The organizational unit (OU) identifier for the system. (pattern: <code>ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}</code>)
sharing_enabled	boolean	Indicates whether cross-account sharing is enabled.
system_arn	string	ARN identifier. (pattern: <code>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}</code>)
system_id	string	System ID for cross-account use without exposing account structure. (pattern: <code>\S{1,255}</code>)
tags	object
updated_at	string (date-time)	The timestamp when the system was last updated.

list_systems

Name	Datatype	Description
name	string	Resource name (used in ARN — no spaces allowed). (pattern: <code>[A-Za-z0-9][A-Za-z0-9_-]{1,59}</code>)
created_at	string (date-time)	The timestamp when the system was created.
organization_id	string	Displayed only if caller has access. (pattern: <code>o-[a-z0-9]{10,32}</code>)
ou_id	string	Displayed only if caller has access. (pattern: <code>ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}</code>)
services_count	integer	The number of services in the system.
system_arn	string	ARN identifier. (pattern: <code>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}</code>)
system_id	string	System ID for cross-account use without exposing account structure. (pattern: <code>\S{1,255}</code>)
updated_at	string (date-time)	The timestamp when the system was last updated.
user_journeys_count	integer	The number of user journeys in the system.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_system	select	systemArn, region		Retrieves a system by ARN.
list_systems	select	region	ouId, maxResults, nextToken	Lists systems.
create_system	insert	region, name		Creates a system that represents a logical grouping of services.
update_system	update	region, systemArn		Updates an existing system.
delete_system	delete	region		Deletes a system.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
systemArn	string
maxResults	integer
nextToken	string
ouId	string	Filter systems by organizational unit (OU) identifier.

SELECT examples

get_system

Retrieves a system by ARN.

SELECT
name,
created_at,
description,
kms_key_id,
organization_id,
ou_id,
sharing_enabled,
system_arn,
system_id,
tags,
updated_at
FROM aws.resiliencehubv2.systems
WHERE systemArn = '{{ systemArn }}' -- required
AND region = '{{ region }}' -- required
;

list_systems

Lists systems.

SELECT
name,
created_at,
organization_id,
ou_id,
services_count,
system_arn,
system_id,
updated_at,
user_journeys_count
FROM aws.resiliencehubv2.systems
WHERE region = '{{ region }}' -- required
AND ouId = '{{ ouId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_system

Creates a system that represents a logical grouping of services.

INSERT INTO aws.resiliencehubv2.systems (
name,
description,
sharingEnabled,
kmsKeyId,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
{{ sharingEnabled }},
'{{ kmsKeyId }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
system
;

Manifest

# Description fields are for documentation purposes
- name: systems
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the systems resource.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name (used in ARN — no spaces allowed).
  - name: description
    value: "{{ description }}"
    description: |
      Resource description.
  - name: sharingEnabled
    value: {{ sharingEnabled }}
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
    description: |
      KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotency token.

UPDATE examples

update_system

Updates an existing system.

UPDATE aws.resiliencehubv2.systems
SET 
systemArn = '{{ systemArn }}',
description = '{{ description }}',
sharingEnabled = {{ sharingEnabled }}
WHERE 
region = '{{ region }}' --required
AND systemArn = '{{ systemArn }}' --required
RETURNING
system;

DELETE examples

delete_system

Deletes a system.

DELETE FROM aws.resiliencehubv2.systems
WHERE region = '{{ region }}' --required
;