home_region_controls

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

Overview

Name	home_region_controls
Type	Resource
Id	aws.migrationhub_config.home_region_controls

Fields

The following fields are returned by SELECT queries:

describe_home_region_controls

Name	Datatype	Description
home_region_controls	array	An array that contains your HomeRegionControl objects.
next_token	string	If a NextToken was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in NextToken. (pattern: <code>^[a-zA-Z0-9/+=]{0,2048}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_home_region_controls	select	region		This API permits filtering on the ControlId and HomeRegion fields.
create_home_region_control	insert	region, HomeRegion, Target		This API sets up the home region for the calling account only.
delete_home_region_control	delete	region		This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.

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_home_region_controls

This API permits filtering on the ControlId and HomeRegion fields.

SELECT
home_region_controls,
next_token
FROM aws.migrationhub_config.home_region_controls
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_home_region_control

This API sets up the home region for the calling account only.

INSERT INTO aws.migrationhub_config.home_region_controls (
HomeRegion,
Target,
DryRun,
region
)
SELECT 
'{{ HomeRegion }}' /* required */,
'{{ Target }}' /* required */,
{{ DryRun }},
'{{ region }}'
RETURNING
home_region_control
;

Manifest

# Description fields are for documentation purposes
- name: home_region_controls
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the home_region_controls resource.
  - name: HomeRegion
    value: "{{ HomeRegion }}"
    description: |
      The name of the home region of the calling account.
  - name: Target
    description: |
      The account for which this command sets up a home region control. The Target is always of type ACCOUNT.
    value:
      Type: "{{ Type }}"
      Id: "{{ Id }}"
  - name: DryRun
    value: {{ DryRun }}
    description: |
      Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has permission to make the call.

DELETE examples

delete_home_region_control

This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.

DELETE FROM aws.migrationhub_config.home_region_controls
WHERE region = '{{ region }}' --required
;