serial_console_access_status
Creates, updates, deletes, gets or lists a serial_console_access_status resource.
Overview
| Name | serial_console_access_status |
| Type | Resource |
| Id | aws.ec2.serial_console_access_status |
Fields
The following fields are returned by SELECT queries:
- get_serial_console_access_status
| Name | Datatype | Description |
|---|---|---|
managed_by | string | The entity that manages access to the serial console. Possible values include: account - Access is managed by the account. declarative-policy - Access is managed by a declarative policy and can't be modified by the account. |
serial_console_access_enabled | boolean | If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_serial_console_access_status | select | region | DryRun | Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide. |
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) |
DryRun | boolean | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. |
SELECT examples
- get_serial_console_access_status
Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
SELECT
managed_by,
serial_console_access_enabled
FROM aws.ec2.serial_console_access_status
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;