Package software.amazon.awscdk.services.devicefarm

Class CfnInstanceProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.devicefarm.CfnInstanceProfile
All Implemented Interfaces:
IInspectable, IInstanceProfileRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:34.146Z") @Stability(Stable) public class CfnInstanceProfile extends CfnResource implements IInspectable, IInstanceProfileRef, ITaggable
Creates a profile that can be applied to one or more private fleet device instances.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.devicefarm.*;
 CfnInstanceProfile cfnInstanceProfile = CfnInstanceProfile.Builder.create(this, "MyCfnInstanceProfile")
         .name("name")
         // the properties below are optional
         .description("description")
         .excludeAppPackagesFromCleanup(List.of("excludeAppPackagesFromCleanup"))
         .packageCleanup(false)
         .rebootAfterUse(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstanceProfile

      protected CfnInstanceProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInstanceProfile

      protected CfnInstanceProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInstanceProfile

      @Stability(Stable) public CfnInstanceProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInstanceProfileProps props)
      Create a new AWS::DeviceFarm::InstanceProfile.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForInstanceProfile

      @Stability(Stable) @NotNull public static String arnForInstanceProfile(@NotNull IInstanceProfileRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnInstanceProfile

      @Stability(Stable) @NotNull public static Boolean isCfnInstanceProfile(@NotNull Object x)
      Checks whether the given object is a CfnInstanceProfile.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the instance profile.

      See Amazon resource names in the General Reference guide .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceProfileRef

      @Stability(Stable) @NotNull public InstanceProfileReference getInstanceProfileRef()
      A reference to a InstanceProfile resource.
      Specified by:
      getInstanceProfileRef in interface IInstanceProfileRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the instance profile.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the instance profile.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the instance profile.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the instance profile.

    • getExcludeAppPackagesFromCleanup

      @Stability(Stable) @Nullable public List<String> getExcludeAppPackagesFromCleanup()
      An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

    • setExcludeAppPackagesFromCleanup

      @Stability(Stable) public void setExcludeAppPackagesFromCleanup(@Nullable List<String> value)
      An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

    • getPackageCleanup

      @Stability(Stable) @Nullable public Object getPackageCleanup()
      When set to true , Device Farm removes app packages after a test run.

      Returns union: either Boolean or IResolvable

    • setPackageCleanup

      @Stability(Stable) public void setPackageCleanup(@Nullable Boolean value)
      When set to true , Device Farm removes app packages after a test run.

    • setPackageCleanup

      @Stability(Stable) public void setPackageCleanup(@Nullable IResolvable value)
      When set to true , Device Farm removes app packages after a test run.

    • getRebootAfterUse

      @Stability(Stable) @Nullable public Object getRebootAfterUse()
      When set to true , Device Farm reboots the instance after a test run.

      Returns union: either Boolean or IResolvable

    • setRebootAfterUse

      @Stability(Stable) public void setRebootAfterUse(@Nullable Boolean value)
      When set to true , Device Farm reboots the instance after a test run.

    • setRebootAfterUse

      @Stability(Stable) public void setRebootAfterUse(@Nullable IResolvable value)
      When set to true , Device Farm reboots the instance after a test run.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.