aws_servicecatalog_cloud_formation_product Resource
Use the aws_servicecatalog_cloud_formation_product
InSpec audit resource to test properties of a single AWS Service Catalog CloudFormation product.
For additional information, including details on parameters and properties, see the AWS documentation on AWS Service Catalog CloudFormation product.
Install
This resource is available in the Chef InSpec AWS resource pack.
For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.
Syntax
Ensure that a product exists.
describe aws_servicecatalog_cloud_formation_product(name: 'PRODUCT_NAME') do
it { should exist }
end
Parameters
name
(required)The name of the product.
Properties
id
- The product view identifier.
product_id
- The product identifier.
name
- The name of the product.
owner
- The owner of the product.
short_description
- Short description of the product.
type
- The product type.
distributor
- The distributor of the product.
has_default_path
- Indicates whether the product has a default path.
support_email
- The email contact information to obtain support for this product.
support_description
- The description of the support for this product.
support_url
- The URL information to obtain support for this product.
Examples
Ensure a product name is available.
describe aws_servicecatalog_cloud_formation_product(name: 'PRODUCT_NAME') do
its('name') { should eq 'PRODUCT_NAME' }
end
Ensure a owner is available.
describe aws_servicecatalog_cloud_formation_product(name: 'PRODUCT_NAME') do
its('owner') { should eq 'PRODUCT_OWNER' }
end
Matchers
For a full list of available matchers, see 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_cloud_formation_product(name: 'PRODUCT_NAME') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_servicecatalog_cloud_formation_product(name: 'PRODUCT_NAME') do
it { should_not exist }
end
be_available
Use should
to check if the entity is available.
describe aws_servicecatalog_cloud_formation_product(name: 'PRODUCT_NAME') do
it { should be_available }
end
AWS Permissions
Your Principal will need the ServiceCatalog:Client:DescribeProductAsAdminOutput
action with Effect
set to Allow
.