1. Packages
  2. AWS
  3. API Docs
  4. devicefarm
  5. InstanceProfile
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.devicefarm.InstanceProfile

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides a resource to manage AWS Device Farm Instance Profiles. ∂

    NOTE: AWS currently has limited regional support for Device Farm (e.g., us-west-2). See AWS Device Farm endpoints and quotas for information on supported regions.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.devicefarm.InstanceProfile("example", {name: "example"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.devicefarm.InstanceProfile("example", name="example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/devicefarm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := devicefarm.NewInstanceProfile(ctx, "example", &devicefarm.InstanceProfileArgs{
    			Name: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.DeviceFarm.InstanceProfile("example", new()
        {
            Name = "example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.devicefarm.InstanceProfile;
    import com.pulumi.aws.devicefarm.InstanceProfileArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new InstanceProfile("example", InstanceProfileArgs.builder()
                .name("example")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:devicefarm:InstanceProfile
        properties:
          name: example
    

    Create InstanceProfile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InstanceProfile(name: string, args?: InstanceProfileArgs, opts?: CustomResourceOptions);
    @overload
    def InstanceProfile(resource_name: str,
                        args: Optional[InstanceProfileArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def InstanceProfile(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        exclude_app_packages_from_cleanups: Optional[Sequence[str]] = None,
                        name: Optional[str] = None,
                        package_cleanup: Optional[bool] = None,
                        reboot_after_use: Optional[bool] = None,
                        tags: Optional[Mapping[str, str]] = None)
    func NewInstanceProfile(ctx *Context, name string, args *InstanceProfileArgs, opts ...ResourceOption) (*InstanceProfile, error)
    public InstanceProfile(string name, InstanceProfileArgs? args = null, CustomResourceOptions? opts = null)
    public InstanceProfile(String name, InstanceProfileArgs args)
    public InstanceProfile(String name, InstanceProfileArgs args, CustomResourceOptions options)
    
    type: aws:devicefarm:InstanceProfile
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InstanceProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var instanceProfileResource = new Aws.DeviceFarm.InstanceProfile("instanceProfileResource", new()
    {
        Description = "string",
        ExcludeAppPackagesFromCleanups = new[]
        {
            "string",
        },
        Name = "string",
        PackageCleanup = false,
        RebootAfterUse = false,
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := devicefarm.NewInstanceProfile(ctx, "instanceProfileResource", &devicefarm.InstanceProfileArgs{
    	Description: pulumi.String("string"),
    	ExcludeAppPackagesFromCleanups: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:           pulumi.String("string"),
    	PackageCleanup: pulumi.Bool(false),
    	RebootAfterUse: pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var instanceProfileResource = new InstanceProfile("instanceProfileResource", InstanceProfileArgs.builder()
        .description("string")
        .excludeAppPackagesFromCleanups("string")
        .name("string")
        .packageCleanup(false)
        .rebootAfterUse(false)
        .tags(Map.of("string", "string"))
        .build());
    
    instance_profile_resource = aws.devicefarm.InstanceProfile("instanceProfileResource",
        description="string",
        exclude_app_packages_from_cleanups=["string"],
        name="string",
        package_cleanup=False,
        reboot_after_use=False,
        tags={
            "string": "string",
        })
    
    const instanceProfileResource = new aws.devicefarm.InstanceProfile("instanceProfileResource", {
        description: "string",
        excludeAppPackagesFromCleanups: ["string"],
        name: "string",
        packageCleanup: false,
        rebootAfterUse: false,
        tags: {
            string: "string",
        },
    });
    
    type: aws:devicefarm:InstanceProfile
    properties:
        description: string
        excludeAppPackagesFromCleanups:
            - string
        name: string
        packageCleanup: false
        rebootAfterUse: false
        tags:
            string: string
    

    InstanceProfile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InstanceProfile resource accepts the following input properties:

    Description string
    The description of the instance profile.
    ExcludeAppPackagesFromCleanups List<string>
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    Name string
    The name for the instance profile.
    PackageCleanup bool
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    RebootAfterUse bool
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Description string
    The description of the instance profile.
    ExcludeAppPackagesFromCleanups []string
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    Name string
    The name for the instance profile.
    PackageCleanup bool
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    RebootAfterUse bool
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    The description of the instance profile.
    excludeAppPackagesFromCleanups List<String>
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name String
    The name for the instance profile.
    packageCleanup Boolean
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    rebootAfterUse Boolean
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description string
    The description of the instance profile.
    excludeAppPackagesFromCleanups string[]
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name string
    The name for the instance profile.
    packageCleanup boolean
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    rebootAfterUse boolean
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description str
    The description of the instance profile.
    exclude_app_packages_from_cleanups Sequence[str]
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name str
    The name for the instance profile.
    package_cleanup bool
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    reboot_after_use bool
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    description String
    The description of the instance profile.
    excludeAppPackagesFromCleanups List<String>
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name String
    The name for the instance profile.
    packageCleanup Boolean
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    rebootAfterUse Boolean
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InstanceProfile resource produces the following output properties:

    Arn string
    The Amazon Resource Name of this instance profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name of this instance profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of this instance profile.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name of this instance profile.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name of this instance profile.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of this instance profile.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing InstanceProfile Resource

    Get an existing InstanceProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceProfileState, opts?: CustomResourceOptions): InstanceProfile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            exclude_app_packages_from_cleanups: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            package_cleanup: Optional[bool] = None,
            reboot_after_use: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> InstanceProfile
    func GetInstanceProfile(ctx *Context, name string, id IDInput, state *InstanceProfileState, opts ...ResourceOption) (*InstanceProfile, error)
    public static InstanceProfile Get(string name, Input<string> id, InstanceProfileState? state, CustomResourceOptions? opts = null)
    public static InstanceProfile get(String name, Output<String> id, InstanceProfileState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name of this instance profile.
    Description string
    The description of the instance profile.
    ExcludeAppPackagesFromCleanups List<string>
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    Name string
    The name for the instance profile.
    PackageCleanup bool
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    RebootAfterUse bool
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name of this instance profile.
    Description string
    The description of the instance profile.
    ExcludeAppPackagesFromCleanups []string
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    Name string
    The name for the instance profile.
    PackageCleanup bool
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    RebootAfterUse bool
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of this instance profile.
    description String
    The description of the instance profile.
    excludeAppPackagesFromCleanups List<String>
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name String
    The name for the instance profile.
    packageCleanup Boolean
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    rebootAfterUse Boolean
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name of this instance profile.
    description string
    The description of the instance profile.
    excludeAppPackagesFromCleanups string[]
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name string
    The name for the instance profile.
    packageCleanup boolean
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    rebootAfterUse boolean
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name of this instance profile.
    description str
    The description of the instance profile.
    exclude_app_packages_from_cleanups Sequence[str]
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name str
    The name for the instance profile.
    package_cleanup bool
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    reboot_after_use bool
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of this instance profile.
    description String
    The description of the instance profile.
    excludeAppPackagesFromCleanups List<String>
    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
    name String
    The name for the instance profile.
    packageCleanup Boolean
    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
    rebootAfterUse Boolean
    When set to true, Device Farm reboots the instance after a test run. The default value is true.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import DeviceFarm Instance Profiles using their ARN. For example:

    $ pulumi import aws:devicefarm/instanceProfile:InstanceProfile example arn:aws:devicefarm:us-west-2:123456789012:instanceprofile:4fa784c7-ccb4-4dbf-ba4f-02198320daa1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi