user_journeys

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

Overview

Name	user_journeys
Type	Resource
Id	aws.resiliencehubv2.user_journeys

Fields

The following fields are returned by SELECT queries:

get_user_journey

Name	Datatype	Description
name	string	Entity label (not part of ARN — spaces allowed). (pattern: <code>[A-Za-z0-9][A-Za-z0-9 _-]{1,59}</code>)
created_at	string (date-time)	The timestamp when the user journey was created.
description	string	Resource description.
policy_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>)
updated_at	string (date-time)	The timestamp when the user journey was last updated.
user_journey_id	string	The unique identifier of the user journey. (pattern: <code>\S{1,255}</code>)

list_user_journeys

Name	Datatype	Description
name	string	Entity label (not part of ARN — spaces allowed). (pattern: <code>[A-Za-z0-9][A-Za-z0-9 _-]{1,59}</code>)
created_at	string (date-time)	The timestamp when the user journey was created.
updated_at	string (date-time)	The timestamp when the user journey was last updated.
user_journey_id	string	The unique identifier of the user journey. (pattern: <code>\S{1,255}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_journey	select	systemArn, userJourneyId, region		Retrieves a user journey.
list_user_journeys	select	systemArn, region	maxResults, nextToken	Lists user journeys for a system.
create_user_journey	insert	region, systemArn, name		Creates a user journey within a system.
update_user_journey	update	region, systemArn, userJourneyId		Updates an existing user journey.
delete_user_journey	delete	region		Deletes a user journey.

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
userJourneyId	string	The identifier of the user journey to retrieve.
maxResults	integer
nextToken	string

SELECT examples

get_user_journey

Retrieves a user journey.

SELECT
name,
created_at,
description,
policy_arn,
updated_at,
user_journey_id
FROM aws.resiliencehubv2.user_journeys
WHERE systemArn = '{{ systemArn }}' -- required
AND userJourneyId = '{{ userJourneyId }}' -- required
AND region = '{{ region }}' -- required
;

list_user_journeys

Lists user journeys for a system.

SELECT
name,
created_at,
updated_at,
user_journey_id
FROM aws.resiliencehubv2.user_journeys
WHERE systemArn = '{{ systemArn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_user_journey

Creates a user journey within a system.

INSERT INTO aws.resiliencehubv2.user_journeys (
systemArn,
name,
description,
policyArn,
clientToken,
region
)
SELECT 
'{{ systemArn }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ policyArn }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
user_journey
;

Manifest

# Description fields are for documentation purposes
- name: user_journeys
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the user_journeys resource.
  - name: systemArn
    value: "{{ systemArn }}"
    description: |
      ARN identifier.
  - name: name
    value: "{{ name }}"
    description: |
      Entity label (not part of ARN — spaces allowed).
  - name: description
    value: "{{ description }}"
    description: |
      Resource description.
  - name: policyArn
    value: "{{ policyArn }}"
    description: |
      ARN identifier.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotency token.

UPDATE examples

update_user_journey

Updates an existing user journey.

UPDATE aws.resiliencehubv2.user_journeys
SET 
systemArn = '{{ systemArn }}',
userJourneyId = '{{ userJourneyId }}',
name = '{{ name }}',
description = '{{ description }}',
policyArn = '{{ policyArn }}'
WHERE 
region = '{{ region }}' --required
AND systemArn = '{{ systemArn }}' --required
AND userJourneyId = '{{ userJourneyId }}' --required
RETURNING
user_journey;

DELETE examples

delete_user_journey

Deletes a user journey.

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