Skip to main content

aws_amplify_app resource

Use the aws_amplify_app InSpec audit resource to test the properties of a single specific AWS Amplify app.

For additional information, including details on parameters and properties, see the AWS documentation on AWS Amplify App.

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 AWS Amplify App exists.

describe aws_amplify_app(app_id: 'APP_ID') do
  it { should exist }
end

Parameters

app_id (required)

The unique ID of the Amplify app.

Properties

app_arn
The Amazon Resource Name (ARN) of the Amplify app.
app_id
The unique ID of the Amplify app.
app_arn
The app’s Amazon Resource app_id (ARN).
name
The name for the Amplify app.
description
The description for the Amplify app.
repository
The repository for the Amplify app.
platform
The platform for the Amplify app.
create_time
Creates a date and time for the Amplify app.
update_time
Updates the date and time for the Amplify app.
environment_variables
The environment variables for the Amplify app.
pending_engine_versions
The app engine version to upgrade to.
default_domain
The default domain for the Amplify app.
enable_branch_auto_build
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
enable_basic_auth
Enables basic authorization for the Amplify app’s branches.

Examples

Ensure a app ID is available.

describe aws_amplify_app(app_id: 'APP_ID') do
  its('app_id') { should eq 'APP_ID' }
end

Ensure a app name is available.

describe aws_amplify_app(app_id: 'APP_ID') do
    its('app_name') { should eq 'APP_NAME' }
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_amplify_app(app_id: 'APP_ID') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_amplify_app(app_id: 'APP_ID') do
  it { should_not exist }
end

be_available

Use should to check if the Amplify App is available.

describe aws_amplify_app(app_id: 'APP_ID') do
  it { should be_available }
end

AWS Permissions

Your Principal will need the Amplify:Client:GetAppResult action with Effect set to Allow.

Edit this page on GitHub

Thank you for your feedback!

×









Search Results