aws_amplify_apps resource
Use the aws_amplify_apps InSpec audit resource to test the properties of Multiple AWS Amplify apps.
For additional information, including details on parameters and properties, see the AWS documentation on AWS Amplify App.
Syntax
Ensure that AWS Amplify app exists.
describe aws_amplify_apps do
it { should exist }
end
Parameters
This resource does not require any parameters.
Properties
app_arns- The Amazon Resource Name (ARN) of the Amplify app.
Field:
app_arnapp_ids- The unique ID of the Amplify app.
Field:
app_idapp_arns- The app’s Amazon Resource app_id (ARN).
Field:
app_arnnames- The name for the Amplify app.
Field:
namedescription- The description for the Amplify app.
Field:
descriptionrepositories- The repository for the Amplify app.
Field:
repositoryplatforms- The platform for the Amplify app.
Field:
platformcreate_time- Creates a date and time for the Amplify app.
Field:
create_timeupdate_time- Updates the date and time for the Amplify app.
Field:
update_timeenvironment_variables- The environment variables for the Amplify app.
Field:
environment_variablespending_engine_versions- The app engine version to upgrade to.
Field:
pending_engine_versiondefault_domains- The default domain for the Amplify app.
Field:
default_domainenable_branch_auto_build- Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
Field:
enable_branch_auto_buildenable_basic_auth- Enables basic authorization for the Amplify app’s branches.
Field:
enable_basic_auth
Examples
Ensure a app ID is available:
describe aws_amplify_apps do
its('app_ids') { should include 'app_id' }
end
Ensure a app name is available:
describe aws_amplify_apps do
its('app_names') { should include 'app_name' }
end
Matchers
For a full list of available matchers, see 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_amplify_apps do
it { should exist }
end
Use should_not to test the entity does not exist.
describe aws_amplify_apps do
it { should_not exist }
end
be_available
Use should to check if the Amplify App is available.
describe aws_amplify_apps do
it { should be_available }
end
AWS Permissions
Your AWS principal will need the Amplify:Client:ListAppsResult action with Effect set to Allow.