cross_account_access_roles
Creates, updates, deletes, gets or lists a cross_account_access_roles resource.
Overview
| Name | cross_account_access_roles |
| Type | Resource |
| Id | aws.inspector.cross_account_access_roles |
Fields
The following fields are returned by SELECT queries:
- describe_cross_account_access_role
| Name | Datatype | Description |
|---|---|---|
registered_at | string (date-time) | The date when the cross-account access role was registered. |
role_arn | string | The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account. |
valid | boolean | A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_cross_account_access_role | select | region | Describes the IAM role that enables Amazon Inspector to access your AWS account. | |
register_cross_account_access_role | insert | region, roleArn | Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments. |
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_cross_account_access_role
Describes the IAM role that enables Amazon Inspector to access your AWS account.
SELECT
registered_at,
role_arn,
valid
FROM aws.inspector.cross_account_access_roles
WHERE region = '{{ region }}' -- required
;
INSERT examples
- register_cross_account_access_role
- Manifest
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
INSERT INTO aws.inspector.cross_account_access_roles (
roleArn,
region
)
SELECT
'{{ roleArn }}' /* required */,
'{{ region }}'
;
# Description fields are for documentation purposes
- name: cross_account_access_roles
props:
- name: region
value: "{{ region }}"
description: Required parameter for the cross_account_access_roles resource.
- name: roleArn
value: "{{ roleArn }}"
description: |
The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.