service_functions

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

Overview

Name	service_functions
Type	Resource
Id	aws.resiliencehubv2.service_functions

Fields

The following fields are returned by SELECT queries:

list_service_functions

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 service function was created.
criticality	string	The criticality level of the service function. (PRIMARY, SUPPLEMENTAL)
description	string	Resource description.
resource_count	integer	The number of resources associated with the service function.
service_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>)
service_function_id	string	The unique identifier of the service function. (pattern: <code>\S{1,255}</code>)
source	string	The source of the service function. (AI_GENERATED, USER)
updated_at	string (date-time)	The timestamp when the service function was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_service_functions	select	serviceArn, region	maxResults, nextToken	Lists service functions for a service.
create_service_function	insert	region, name, serviceArn, criticality		Creates a service function within a service.
update_service_function	update	region, serviceArn, serviceFunctionId		Updates a service function.
delete_service_function	delete	region		Deletes a service function.

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)
serviceArn	string
maxResults	integer
nextToken	string

SELECT examples

list_service_functions

Lists service functions for a service.

SELECT
name,
created_at,
criticality,
description,
resource_count,
service_arn,
service_function_id,
source,
updated_at
FROM aws.resiliencehubv2.service_functions
WHERE serviceArn = '{{ serviceArn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_service_function

Creates a service function within a service.

INSERT INTO aws.resiliencehubv2.service_functions (
name,
serviceArn,
description,
criticality,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ serviceArn }}' /* required */,
'{{ description }}',
'{{ criticality }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
service_function
;

Manifest

# Description fields are for documentation purposes
- name: service_functions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_functions resource.
  - name: name
    value: "{{ name }}"
    description: |
      Entity label (not part of ARN — spaces allowed).
  - name: serviceArn
    value: "{{ serviceArn }}"
    description: |
      ARN identifier.
  - name: description
    value: "{{ description }}"
    description: |
      Resource description.
  - name: criticality
    value: "{{ criticality }}"
    valid_values: ['PRIMARY', 'SUPPLEMENTAL']
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotency token.

UPDATE examples

update_service_function

Updates a service function.

UPDATE aws.resiliencehubv2.service_functions
SET 
serviceArn = '{{ serviceArn }}',
serviceFunctionId = '{{ serviceFunctionId }}',
name = '{{ name }}',
description = '{{ description }}',
criticality = '{{ criticality }}'
WHERE 
region = '{{ region }}' --required
AND serviceArn = '{{ serviceArn }}' --required
AND serviceFunctionId = '{{ serviceFunctionId }}' --required
RETURNING
service_function;

DELETE examples

delete_service_function

Deletes a service function.

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