target_account_configurations

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

Overview

Name	target_account_configurations
Type	Resource
Id	aws.fis.target_account_configurations

Fields

The following fields are returned by SELECT queries:

get_target_account_configuration

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID of the target account. (pattern: <code>[\S]+</code>)
description	string	The description of the target account. (pattern: <code>[\s\S]*</code>)
role_arn	string	The Amazon Resource Name (ARN) of an IAM role for the target account. (pattern: <code>[\S]+</code>)

list_target_account_configurations

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID of the target account. (pattern: <code>[\S]+</code>)
description	string	The description of the target account. (pattern: <code>[\s\S]*</code>)
role_arn	string	The Amazon Resource Name (ARN) of an IAM role for the target account. (pattern: <code>[\S]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_target_account_configuration	select	id, account_id, region		Gets information about the specified target account configuration of the experiment template.
list_target_account_configurations	select	id, region	maxResults, nextToken	Lists the target account configurations of the specified experiment template.
create_target_account_configuration	insert	id, account_id, region, roleArn		Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Service User Guide.
update_target_account_configuration	update	id, account_id, region		Updates the target account configuration for the specified experiment template.
delete_target_account_configuration	delete	id, account_id, region		Deletes the specified target account configuration of the experiment template.

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
account_id	string	The Amazon Web Services account ID of the target account.
id	string	The ID of the experiment template.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken	string	The token for the next page of results.

SELECT examples

get_target_account_configuration

Gets information about the specified target account configuration of the experiment template.

SELECT
account_id,
description,
role_arn
FROM aws.fis.target_account_configurations
WHERE id = '{{ id }}' -- required
AND account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_target_account_configurations

Lists the target account configurations of the specified experiment template.

SELECT
account_id,
description,
role_arn
FROM aws.fis.target_account_configurations
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_target_account_configuration

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Service User Guide.

INSERT INTO aws.fis.target_account_configurations (
clientToken,
roleArn,
description,
id,
account_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ roleArn }}' /* required */,
'{{ description }}',
'{{ id }}',
'{{ account_id }}',
'{{ region }}'
RETURNING
target_account_configuration
;

Manifest

# Description fields are for documentation purposes
- name: target_account_configurations
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the target_account_configurations resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the target_account_configurations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the target_account_configurations resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: description
    value: "{{ description }}"

UPDATE examples

update_target_account_configuration

Updates the target account configuration for the specified experiment template.

UPDATE aws.fis.target_account_configurations
SET 
roleArn = '{{ roleArn }}',
description = '{{ description }}'
WHERE 
id = '{{ id }}' --required
AND account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
RETURNING
target_account_configuration;

DELETE examples

delete_target_account_configuration

Deletes the specified target account configuration of the experiment template.

DELETE FROM aws.fis.target_account_configurations
WHERE id = '{{ id }}' --required
AND account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
;