enrollment_configurations
Creates, updates, deletes, gets or lists an enrollment_configurations resource.
Overview
| Name | enrollment_configurations |
| Type | Resource |
| Id | aws.compute_optimizer_automation.enrollment_configurations |
Fields
The following fields are returned by SELECT queries:
- get_enrollment_configuration
| Name | Datatype | Description |
|---|---|---|
last_updated_timestamp | string (date-time) | The timestamp of the last update to the enrollment configuration. |
organization_rule_mode | string | Specifies whether the management account can create Automation rules that implement optimization actions for this account. (AnyAllowed, NoneAllowed) |
status | string | The current enrollment status. (Active, Inactive, Pending, Failed) |
status_reason | string | The reason for the current enrollment status. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_enrollment_configuration | select | region | Retrieves the current enrollment configuration for Compute Optimizer Automation. | |
update_enrollment_configuration | update | region, status | Updates your account’s Compute Optimizer Automation enrollment configuration. |
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
- get_enrollment_configuration
Retrieves the current enrollment configuration for Compute Optimizer Automation.
SELECT
last_updated_timestamp,
organization_rule_mode,
status,
status_reason
FROM aws.compute_optimizer_automation.enrollment_configurations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_enrollment_configuration
Updates your account’s Compute Optimizer Automation enrollment configuration.
UPDATE aws.compute_optimizer_automation.enrollment_configurations
SET
status = '{{ status }}',
clientToken = '{{ clientToken }}'
WHERE
region = '{{ region }}' --required
AND status = '{{ status }}' --required
RETURNING
last_updated_timestamp,
status,
status_reason;