aws_servicecatalog_portfolio_principal_association Resource

[edit on GitHub]

Use the aws_servicecatalog_portfolio_principal_association InSpec audit resource to test properties of a single specific AWS Service Catalog portfolio principal association.

For additional information, including details on parameters and properties, see the AWS documentation on AWS Service Catalog Portfolio Principal Association.

Installation

This resource is available in the Chef InSpec AWS resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack.

Syntax

Ensure that a portfolio is available.

describe aws_servicecatalog_portfolio_principal_association(portfolio_id: 'PORTFOLIO_ID') do
  it { should exist }
end

Parameters

portfolio_id (required)

The ID of the portfolio.

Properties

principal_arn

The ARN of the principal (IAM user, role, or group).

principal_type

The principal type. The supported value is IAM.

Examples

Ensure a principal ARN is available.

describe aws_servicecatalog_portfolio_principal_association(portfolio_id: 'PORTFOLIO_ID') do
  its('principal_arn') { should eq 'principal_arn' }
end

Ensure a principal type is ‘IAM’.

describe aws_servicecatalog_portfolio_principal_association(portfolio_id: 'PORTFOLIO_ID') do
    its('principal_type') { should eq 'IAM' }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

The controls will pass if the describe method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_servicecatalog_portfolio_principal_association(portfolio_id: 'PORTFOLIO_ID') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_servicecatalog_portfolio_principal_association(portfolio_id: 'PORTFOLIO_ID') do
  it { should_not exist }
end

be_available

Use should to check if the entity is available.

describe aws_servicecatalog_portfolio_principal_association(portfolio_id: 'PORTFOLIO_ID') do
  it { should be_available }
end

AWS Permissions

Your Principal will need the ServiceCatalog:Client:ListPrincipalsForPortfolioOutput action with Effect set to Allow.