target_account_configurations

Creates, updates, deletes or gets a target_account_configuration resource or lists target_account_configurations in a region

Overview

Name	target_account_configurations
Type	Resource
Description	Resource schema for AWS::FIS::TargetAccountConfiguration
Id	aws.fis.target_account_configurations

Fields

Name	Datatype	Description
experiment_template_id	string	The ID of the experiment template.
account_id	string	The AWS account ID of the target account.
role_arn	string	The Amazon Resource Name (ARN) of an IAM role for the target account.
description	string	The description of the target account.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ExperimentTemplateId, AccountId, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all target_account_configurations in a region.

SELECT
region,
experiment_template_id,
account_id,
role_arn,
description
FROM aws.fis.target_account_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual target_account_configuration.

SELECT
region,
experiment_template_id,
account_id,
role_arn,
description
FROM aws.fis.target_account_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<ExperimentTemplateId>|<AccountId>';

INSERT example

Use the following StackQL query and manifest file to create a new target_account_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.fis.target_account_configurations (
 ExperimentTemplateId,
 AccountId,
 RoleArn,
 region
)
SELECT 
'{{ ExperimentTemplateId }}',
 '{{ AccountId }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.fis.target_account_configurations (
 ExperimentTemplateId,
 AccountId,
 RoleArn,
 Description,
 region
)
SELECT 
 '{{ ExperimentTemplateId }}',
 '{{ AccountId }}',
 '{{ RoleArn }}',
 '{{ Description }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: target_account_configuration
    props:
      - name: ExperimentTemplateId
        value: '{{ ExperimentTemplateId }}'
      - name: AccountId
        value: '{{ AccountId }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Description
        value: '{{ Description }}'

DELETE example

/*+ delete */
DELETE FROM aws.fis.target_account_configurations
WHERE data__Identifier = '<ExperimentTemplateId|AccountId>'
AND region = 'us-east-1';

Permissions

To operate on the target_account_configurations resource, the following permissions are required:

Create

fis:CreateTargetAccountConfiguration

Read

fis:GetTargetAccountConfiguration

Update

fis:UpdateTargetAccountConfiguration

Delete

fis:DeleteTargetAccountConfiguration

List

fis:ListTargetAccountConfigurations