Package software.amazon.awscdk.services.panorama

Class CfnApplicationInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.panorama.CfnApplicationInstance
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.697Z") @Stability(Stable) public class CfnApplicationInstance extends CfnResource implements IInspectable
A CloudFormation AWS::Panorama::ApplicationInstance.

Creates an application instance and deploys it to a device.

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.panorama.*;
 CfnApplicationInstance cfnApplicationInstance = CfnApplicationInstance.Builder.create(this, "MyCfnApplicationInstance")
         .defaultRuntimeContextDevice("defaultRuntimeContextDevice")
         .manifestPayload(ManifestPayloadProperty.builder()
                 .payloadData("payloadData")
                 .build())
         // the properties below are optional
         .applicationInstanceIdToReplace("applicationInstanceIdToReplace")
         .description("description")
         .deviceId("deviceId")
         .manifestOverridesPayload(ManifestOverridesPayloadProperty.builder()
                 .payloadData("payloadData")
                 .build())
         .name("name")
         .runtimeRoleArn("runtimeRoleArn")
         .statusFilter("statusFilter")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnApplicationInstance

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

    • CfnApplicationInstance

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

    • CfnApplicationInstance

      @Stability(Stable) public CfnApplicationInstance(@NotNull Construct scope, @NotNull String id, @NotNull CfnApplicationInstanceProps props)
      Create a new AWS::Panorama::ApplicationInstance.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getAttrApplicationInstanceId

      @Stability(Stable) @NotNull public String getAttrApplicationInstanceId()
      The application instance's ID.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The application instance's ARN.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public Number getAttrCreatedTime()
      The application instance's created time.

    • getAttrDefaultRuntimeContextDeviceName

      @Stability(Stable) @NotNull public String getAttrDefaultRuntimeContextDeviceName()
      The application instance's default runtime context device name.

    • getAttrHealthStatus

      @Stability(Stable) @NotNull public String getAttrHealthStatus()
      The application instance's health status.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public Number getAttrLastUpdatedTime()
      The application instance's last updated time.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The application instance's status.

    • getAttrStatusDescription

      @Stability(Stable) @NotNull public String getAttrStatusDescription()
      The application instance's status description.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tags for the application instance.

    • getDefaultRuntimeContextDevice

      @Stability(Stable) @NotNull public String getDefaultRuntimeContextDevice()
      The device's ID.

    • setDefaultRuntimeContextDevice

      @Stability(Stable) public void setDefaultRuntimeContextDevice(@NotNull String value)
      The device's ID.

    • getManifestPayload

      @Stability(Stable) @NotNull public Object getManifestPayload()
      The application's manifest document.

    • setManifestPayload

      @Stability(Stable) public void setManifestPayload(@NotNull CfnApplicationInstance.ManifestPayloadProperty value)
      The application's manifest document.

    • setManifestPayload

      @Stability(Stable) public void setManifestPayload(@NotNull IResolvable value)
      The application's manifest document.

    • getApplicationInstanceIdToReplace

      @Stability(Stable) @Nullable public String getApplicationInstanceIdToReplace()
      The ID of an application instance to replace with the new instance.

    • setApplicationInstanceIdToReplace

      @Stability(Stable) public void setApplicationInstanceIdToReplace(@Nullable String value)
      The ID of an application instance to replace with the new instance.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the application instance.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the application instance.

    • getDeviceId

      @Stability(Stable) @Nullable public String getDeviceId()
      A device's ID.

    • setDeviceId

      @Stability(Stable) public void setDeviceId(@Nullable String value)
      A device's ID.

    • getManifestOverridesPayload

      @Stability(Stable) @Nullable public Object getManifestOverridesPayload()
      Setting overrides for the application manifest.

    • setManifestOverridesPayload

      @Stability(Stable) public void setManifestOverridesPayload(@Nullable IResolvable value)
      Setting overrides for the application manifest.

    • setManifestOverridesPayload

      @Stability(Stable) public void setManifestOverridesPayload(@Nullable CfnApplicationInstance.ManifestOverridesPayloadProperty value)
      Setting overrides for the application manifest.

    • getName

      @Stability(Stable) @Nullable public String getName()
      A name for the application instance.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A name for the application instance.

    • getRuntimeRoleArn

      @Stability(Stable) @Nullable public String getRuntimeRoleArn()
      The ARN of a runtime role for the application instance.

    • setRuntimeRoleArn

      @Stability(Stable) public void setRuntimeRoleArn(@Nullable String value)
      The ARN of a runtime role for the application instance.

    • getStatusFilter

      @Stability(Stable) @Nullable public String getStatusFilter()
      Only include instances with a specific status.

    • setStatusFilter

      @Stability(Stable) public void setStatusFilter(@Nullable String value)
      Only include instances with a specific status.