Use the aws_ram_resource_shares
InSpec audit resource to test properties of multiple AWS RAM resource shares.
For additional information, including details on parameters and properties, see the AWS documentation on AWS RAM Resource Share.
Syntax
Ensure that a resource exists.
describe aws_ram_resource_shares(resource_owner: 'SELF') do
it { should exist }
end
Parameters
resource_owner
(required)The type of owner. Possible values:
SELF
andOTHER-ACCOUNTS
.
Properties
- The Amazon Resource Name (ARN) of the resource share.
names
- The name of the resource share.
owning_account_ids
- The ID of the AWS account that owns the resource share.
allow_external_principals
- Indicates whether principals outside your AWS organization can be associated with a resource share.
statuses
- The status of the resource share.
status_messages
- A message about the status of the resource share.
- The tags for the resource share.
creation_times
- The time when the resource share was created.
last_updated_times
- The time when the resource share was last updated.
feature_sets
- Indicates how the resource share was created. Possible values include
CREATED_FROM_POLICY
,PROMOTING_TO_STANDARD
, andSTANDARD
.
Examples
Ensure a resource ARN is available:
describe aws_ram_resource_shares(resource_owner: 'SELF') do
its('resource_share_arns') { should include 'RESOURCE_SHARE_ARN' }
end
Ensure that a resource share has an ACTIVE
status:
describe aws_ram_resource_shares(resource_owner: 'SELF') do
its('statuses') { should include 'ACTIVE' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exist
Use should
to test that the entity exists.
describe aws_ram_resource_shares(resource_owner: 'SELF') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_ram_resource_shares(resource_owner: 'dummy') do
it { should_not exist }
end
be_available
Use should
to check if the resource is available.
describe aws_ram_resource_shares(resource_owner: 'SELF') do
it { should be_available }
end
AWS Permissions
Your AWS principal will need the RAM:Client:GetResourceSharesResponse
action with Effect
set to Allow
.