aws_servicecatalog_portfolio_product_associations Resource

[edit on GitHub]

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

For additional information, including details on parameters and properties, see the AWS documentation on AWS Service Catalog Portfolio Product 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 exists.

describe aws_servicecatalog_portfolio_product_associations(product_id: 'PRODUCT_ID') do
  it { should exist }
end

Parameters

product_id (required)

The product identifier.

Properties

ids

The portfolio identifier.

arns

The ARN assigned to the portfolio.

display_names

The name to use for display purposes.

descriptions

The description of the portfolio.

created_times

The UTC time stamp of the creation time.

provider_names

The name of the portfolio provider.

Examples

Ensure a product name is available.

describe aws_servicecatalog_portfolio_product_association(product_id: 'PRODUCT_ID') do
  its('ids') { should include 'PORTFOLIO_ID' }
end

Ensure a status is available.

describe aws_servicecatalog_portfolio_product_association(product_id: 'PRODUCT_ID') do
    its('provider_names') { should include 'PORTFOLIO_PROVIDER_NAME' }
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 list method returns at least one result.

exist

Use should to test that the entity exists.

describe aws_servicecatalog_portfolio_product_associations(product_id: 'PRODUCT_ID') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_servicecatalog_portfolio_product_associations(product_id: 'PRODUCT_ID') do
  it { should_not exist }
end

AWS Permissions

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