app_version_app_components

Creates, updates, deletes, gets or lists an app_version_app_components resource.

Overview

Name	app_version_app_components
Type	Resource
Id	aws.resiliencehub.app_version_app_components

Fields

The following fields are returned by SELECT queries:

describe_app_version_app_component

Name	Datatype	Description
app_arn	string	Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide. (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>)
app_component	object	Defines an Application Component.
app_version	string	Resilience Hub application version. (pattern: <code>^\S{1,50}$</code>)

list_app_version_app_components

Name	Datatype	Description
app_arn	string	Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide. (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>)
app_components	array	Defines an Application Component.
app_version	string	Resilience Hub application version. (pattern: <code>^\S{1,50}$</code>)
next_token	string	Token for the next set of results, or null if there are no more results. (pattern: <code>^\S{1,2000}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_app_version_app_component	select	region		Describes an Application Component in the Resilience Hub application.
list_app_version_app_components	select	region		Lists all the Application Components in the Resilience Hub application.
create_app_version_app_component	insert	region, appArn, name, type		Creates a new Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
update_app_version_app_component	update	region, appArn, id		Updates an existing Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
delete_app_version_app_component	delete	region		Deletes an Application Component from the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API. You will not be able to delete an Application Component if it has resources associated with it.

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)

SELECT examples

describe_app_version_app_component

Describes an Application Component in the Resilience Hub application.

SELECT
app_arn,
app_component,
app_version
FROM aws.resiliencehub.app_version_app_components
WHERE region = '{{ region }}' -- required
;

list_app_version_app_components

Lists all the Application Components in the Resilience Hub application.

SELECT
app_arn,
app_components,
app_version,
next_token
FROM aws.resiliencehub.app_version_app_components
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_app_version_app_component

Creates a new Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

INSERT INTO aws.resiliencehub.app_version_app_components (
additionalInfo,
appArn,
clientToken,
id,
name,
type,
region
)
SELECT 
'{{ additionalInfo }}',
'{{ appArn }}' /* required */,
'{{ clientToken }}',
'{{ id }}',
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ region }}'
RETURNING
app_arn,
app_component,
app_version
;

Manifest

# Description fields are for documentation purposes
- name: app_version_app_components
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_version_app_components resource.
  - name: additionalInfo
    value: "{{ additionalInfo }}"
  - name: appArn
    value: "{{ appArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: id
    value: "{{ id }}"
  - name: name
    value: "{{ name }}"
  - name: type
    value: "{{ type }}"

UPDATE examples

update_app_version_app_component

Updates an existing Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.

UPDATE aws.resiliencehub.app_version_app_components
SET 
additionalInfo = '{{ additionalInfo }}',
appArn = '{{ appArn }}',
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}'
WHERE 
region = '{{ region }}' --required
AND appArn = '{{ appArn }}' --required
AND id = '{{ id }}' --required
RETURNING
app_arn,
app_component,
app_version;

DELETE examples

delete_app_version_app_component

Deletes an Application Component from the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API. You will not be able to delete an Application Component if it has resources associated with it.

DELETE FROM aws.resiliencehub.app_version_app_components
WHERE region = '{{ region }}' --required
;