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	awscc.fis.target_account_configurations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
experiment_template_id	string	The ID of the experiment template.
account_id	string	The AWS account ID of the target account.
region	string	AWS region.

For more information, see AWS::FIS::TargetAccountConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	target_account_configurations	INSERT	ExperimentTemplateId, AccountId, RoleArn, region
delete_resource	target_account_configurations	DELETE	Identifier, region
update_resource	target_account_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	target_account_configurations_list_only	SELECT	region
get_resource	target_account_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual target_account_configuration.

SELECT
  region,
  experiment_template_id,
  account_id,
  role_arn,
  description
FROM awscc.fis.target_account_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ experiment_template_id }}|{{ account_id }}';

list (identifiers only)

Lists all target_account_configurations in a region.

SELECT
  region,
  experiment_template_id,
  account_id
FROM awscc.fis.target_account_configurations_list_only
WHERE
  region = 'us-east-1';

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 awscc.fis.target_account_configurations (
  ExperimentTemplateId,
  AccountId,
  RoleArn,
  region
)
SELECT
  '{{ experiment_template_id }}',
  '{{ account_id }}',
  '{{ role_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.fis.target_account_configurations (
  ExperimentTemplateId,
  AccountId,
  RoleArn,
  Description,
  region
)
SELECT
  '{{ experiment_template_id }}',
  '{{ account_id }}',
  '{{ role_arn }}',
  '{{ 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: experiment_template_id
        value: '{{ experiment_template_id }}'
      - name: account_id
        value: '{{ account_id }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: description
        value: '{{ description }}'

UPDATE example

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

/*+ update */
UPDATE awscc.fis.target_account_configurations
SET PatchDocument = string('{{ {
    "RoleArn": role_arn,
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ experiment_template_id }}|{{ account_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.fis.target_account_configurations
WHERE
  Identifier = '{{ experiment_template_id }}|{{ account_id }}' 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