This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DeviceFarm::InstanceProfile
<a name="aws-resource-devicefarm-instanceprofile"></a>

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

## Syntax
<a name="aws-resource-devicefarm-instanceprofile-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-devicefarm-instanceprofile-syntax.json"></a>

```
{
  "Type" : "AWS::DeviceFarm::InstanceProfile",
  "Properties" : {
      "[Description](#cfn-devicefarm-instanceprofile-description)" : String,
      "[ExcludeAppPackagesFromCleanup](#cfn-devicefarm-instanceprofile-excludeapppackagesfromcleanup)" : [ String, ... ],
      "[Name](#cfn-devicefarm-instanceprofile-name)" : String,
      "[PackageCleanup](#cfn-devicefarm-instanceprofile-packagecleanup)" : Boolean,
      "[RebootAfterUse](#cfn-devicefarm-instanceprofile-rebootafteruse)" : Boolean,
      "[Tags](#cfn-devicefarm-instanceprofile-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-devicefarm-instanceprofile-syntax.yaml"></a>

```
Type: AWS::DeviceFarm::InstanceProfile
Properties:
  [Description](#cfn-devicefarm-instanceprofile-description): String
  [ExcludeAppPackagesFromCleanup](#cfn-devicefarm-instanceprofile-excludeapppackagesfromcleanup): 
    - String
  [Name](#cfn-devicefarm-instanceprofile-name): String
  [PackageCleanup](#cfn-devicefarm-instanceprofile-packagecleanup): Boolean
  [RebootAfterUse](#cfn-devicefarm-instanceprofile-rebootafteruse): Boolean
  [Tags](#cfn-devicefarm-instanceprofile-tags): 
    - Tag
```

## Properties
<a name="aws-resource-devicefarm-instanceprofile-properties"></a>

`Description`  <a name="cfn-devicefarm-instanceprofile-description"></a>
The description of the instance profile.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `16384`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExcludeAppPackagesFromCleanup`  <a name="cfn-devicefarm-instanceprofile-excludeapppackagesfromcleanup"></a>
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`.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-devicefarm-instanceprofile-name"></a>
The name of the instance profile.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PackageCleanup`  <a name="cfn-devicefarm-instanceprofile-packagecleanup"></a>
When set to `true`, Device Farm removes app packages after a test run. The default value is `false` for private devices.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RebootAfterUse`  <a name="cfn-devicefarm-instanceprofile-rebootafteruse"></a>
When set to `true`, Device Farm reboots the instance after a test run. The default value is `true`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-devicefarm-instanceprofile-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation guide*.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-devicefarm-instanceprofile-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-devicefarm-instanceprofile-return-values"></a>

### Ref
<a name="aws-resource-devicefarm-instanceprofile-return-values-ref"></a>

Not supported for this resource.

### Fn::GetAtt
<a name="aws-resource-devicefarm-instanceprofile-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-devicefarm-instanceprofile-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the instance profile. See [Amazon resource names](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference guide*.

# AWS::DeviceFarm::InstanceProfile Tag
<a name="aws-properties-devicefarm-instanceprofile-tag"></a>

The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters. 

## Syntax
<a name="aws-properties-devicefarm-instanceprofile-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-devicefarm-instanceprofile-tag-syntax.json"></a>

```
{
  "[Key](#cfn-devicefarm-instanceprofile-tag-key)" : String,
  "[Value](#cfn-devicefarm-instanceprofile-tag-value)" : String
}
```

### YAML
<a name="aws-properties-devicefarm-instanceprofile-tag-syntax.yaml"></a>

```
  [Key](#cfn-devicefarm-instanceprofile-tag-key): String
  [Value](#cfn-devicefarm-instanceprofile-tag-value): String
```

## Properties
<a name="aws-properties-devicefarm-instanceprofile-tag-properties"></a>

`Key`  <a name="cfn-devicefarm-instanceprofile-tag-key"></a>
One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-devicefarm-instanceprofile-tag-value"></a>
The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key).  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)