instance_profiles

Creates, updates, deletes, gets or lists an instance_profiles resource.

Overview

Name	instance_profiles
Type	Resource
Id	aws.devicefarm.instance_profiles

Fields

The following fields are returned by SELECT queries:

get_instance_profile

Name	Datatype	Description
name	string	The name of the instance profile.
arn	string	The Amazon Resource Name (ARN) of the instance profile. (pattern: <code>^arn:aws:devicefarm:.+</code>)
description	string	The description of the instance profile.
exclude_app_packages_from_cleanup	array	An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes. The list of packages is considered only if you set packageCleanup to true.
package_cleanup	boolean	When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
reboot_after_use	boolean	When set to true, Device Farm reboots the instance after a test run. The default value is true.

list_instance_profiles

Name	Datatype	Description
name	string	The name of the instance profile.
arn	string	The Amazon Resource Name (ARN) of the instance profile. (pattern: <code>^arn:aws:devicefarm:.+</code>)
description	string	The description of the instance profile.
exclude_app_packages_from_cleanup	array	An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes. The list of packages is considered only if you set packageCleanup to true.
package_cleanup	boolean	When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
reboot_after_use	boolean	When set to true, Device Farm reboots the instance after a test run. The default value is true.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instance_profile	select	region		Returns information about the specified instance profile.
list_instance_profiles	select	region		Returns information about all the instance profiles in an AWS account.
create_instance_profile	insert	region, name		Creates a profile that can be applied to one or more private fleet device instances.
update_instance_profile	update	region, arn		Updates information about an existing private device instance profile.
delete_instance_profile	delete	region		Deletes a profile that can be applied to one or more private device instances.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_instance_profile

Returns information about the specified instance profile.

SELECT
name,
arn,
description,
exclude_app_packages_from_cleanup,
package_cleanup,
reboot_after_use
FROM aws.devicefarm.instance_profiles
WHERE region = '{{ region }}' -- required
;

list_instance_profiles

Returns information about all the instance profiles in an AWS account.

SELECT
name,
arn,
description,
exclude_app_packages_from_cleanup,
package_cleanup,
reboot_after_use
FROM aws.devicefarm.instance_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_instance_profile

Creates a profile that can be applied to one or more private fleet device instances.

INSERT INTO aws.devicefarm.instance_profiles (
name,
description,
packageCleanup,
excludeAppPackagesFromCleanup,
rebootAfterUse,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
{{ packageCleanup }},
'{{ excludeAppPackagesFromCleanup }}',
{{ rebootAfterUse }},
'{{ region }}'
RETURNING
instance_profile
;

Manifest

# Description fields are for documentation purposes
- name: instance_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the instance_profiles resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of your instance profile.
  - name: description
    value: "{{ description }}"
    description: |
      The description of your instance profile.
  - name: packageCleanup
    value: {{ packageCleanup }}
    description: |
      When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
  - name: excludeAppPackagesFromCleanup
    value:
      - "{{ excludeAppPackagesFromCleanup }}"
    description: |
      An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run. The list of packages is considered only if you set packageCleanup to true.
  - name: rebootAfterUse
    value: {{ rebootAfterUse }}
    description: |
      When set to true, Device Farm reboots the instance after a test run. The default value is true.

UPDATE examples

update_instance_profile

Updates information about an existing private device instance profile.

UPDATE aws.devicefarm.instance_profiles
SET 
arn = '{{ arn }}',
name = '{{ name }}',
description = '{{ description }}',
packageCleanup = {{ packageCleanup }},
excludeAppPackagesFromCleanup = '{{ excludeAppPackagesFromCleanup }}',
rebootAfterUse = {{ rebootAfterUse }}
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
instance_profile;

DELETE examples

delete_instance_profile

Deletes a profile that can be applied to one or more private device instances.

DELETE FROM aws.devicefarm.instance_profiles
WHERE region = '{{ region }}' --required
;