An AWS Route53 task group is a collection of one or more tasks allowing you to specify various zone filters to retrieve DNS zone data from AWS Route53 service using specified AWS user credentials. Grouping these tasks together helps organize related groups of sync data, enable/disable these and manage the grid member these run on.
References to awsrte53taskgroup are object references.
The name part of the name server group object reference has the following components:
- Name of the AWS Route53 task group
Example: awsrte53taskgroup/ZG5zLmJpbmRfY25h:extdatagroup
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): account_id, comment, disabled, name, sync_child_accounts, sync_status.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| consolidated_view | See the field description for more information |
| grid_member | |
| name | |
| network_view | See the field description for more information |
The AWS Account ID associated with this task group.
Type
String.
Search
The field is available for search via
Notes
The account_id is part of the base object.
The account_id cannot be updated.
account_id cannot be written.
Comment for the task group; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
Indicates if all zones need to be saved into a single view.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
The consolidate_zones cannot be updated.
The name of the DNS view for consolidating zones.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The consolidated view is required if consolidate_zones is set and network_view_mapping_policy is DIRECT
Search
The field is available for search via
Notes
The consolidated_view cannot be updated.
Indicates if the task group is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
The disabled is part of the base object.
Member on which the tasks in this task group will be run.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
The name of this AWS Route53 sync task group.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The name of the tenant’s network view.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The network view required if network_view_mapping_policy is set to DIRECT
Search
The field is available for search via
Notes
The network_view cannot be updated.
The network view mapping policy.
Type
String.
Create
The default value is AUTO_CREATE.
Search
The field is available for search via
Notes
The network_view_mapping_policy cannot be updated.
Role ARN for syncing child accounts; maximum 128 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Synchronizing child accounts is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
The sync_child_accounts is part of the base object.
Indicate the overall sync status of this task group.
Type
String.
Search
The field is available for search via
Notes
The sync_status is part of the base object.
The sync_status cannot be updated.
sync_status cannot be written.
List of AWS Route53 tasks in this group.
Type
A/An AWS Route53 task struct array.
Create
The default value is:
empty
Search
The field is not available for search.
This function performs action on a task. Current support is for RUN action.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
action ( String. Valid values are: “RUN” ). This parameter is mandatory. The task control action to perform. Currently only start is supported.
task_name ( String. ) This field containes the name of the task to perform this action on.
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| account_id | String | N | Y | Y | = |
| comment | String | N | N | Y | : = ~ |
| consolidate_zones | Bool | N | N | N | = |
| consolidated_view | String | Y* | N | N | = |
| disabled | Bool | N | N | Y | = |
| grid_member | String | Y | N | N | = |
| name | String | Y | N | Y | : = ~ |
| network_view | String | Y* | N | N | = |
| network_view_mapping_policy | String | N | N | N | = |
| role_arn | String | N | N | N | : = ~ |
| sync_child_accounts | Bool | N | N | Y | = |
| sync_status | String | N | Y | Y | = |
| task_list | [struct] | N | N | N | N/A |
* Required in some cases, see detailed field description above.
