software.amazon.awscdk.services.panorama

Class CfnApplicationInstance

java.lang.Object

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:35.076Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplicationInstance.Builder A fluent builder for CfnApplicationInstance.
static interface	CfnApplicationInstance.ManifestOverridesPayloadProperty Parameter overrides for an application instance.
static interface	CfnApplicationInstance.ManifestPayloadProperty A application verion's manifest file.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplicationInstance(Construct scope, java.lang.String id, CfnApplicationInstanceProps props) Create a new `AWS::Panorama::ApplicationInstance`.
protected	CfnApplicationInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationInstance(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationInstanceIdToReplace() The ID of an application instance to replace with the new instance.
java.lang.String	getAttrApplicationInstanceId() The application instance's ID.
java.lang.String	getAttrArn() The application instance's ARN.
java.lang.Number	getAttrCreatedTime() The application instance's created time.
java.lang.String	getAttrDefaultRuntimeContextDeviceName() The application instance's default runtime context device name.
java.lang.String	getAttrHealthStatus() The application instance's health status.
java.lang.Number	getAttrLastUpdatedTime() The application instance's last updated time.
java.lang.String	getAttrStatus() The application instance's status.
java.lang.String	getAttrStatusDescription() The application instance's status description.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDefaultRuntimeContextDevice() The device's ID.
java.lang.String	getDescription() A description for the application instance.
java.lang.String	getDeviceId() A device's ID.
java.lang.Object	getManifestOverridesPayload() Setting overrides for the application manifest.
java.lang.Object	getManifestPayload() The application's manifest document.
java.lang.String	getName() A name for the application instance.
java.lang.String	getRuntimeRoleArn() The ARN of a runtime role for the application instance.
java.lang.String	getStatusFilter() Only include instances with a specific status.
TagManager	getTags() Tags for the application instance.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApplicationInstanceIdToReplace(java.lang.String value) The ID of an application instance to replace with the new instance.
void	setDefaultRuntimeContextDevice(java.lang.String value) The device's ID.
void	setDescription(java.lang.String value) A description for the application instance.
void	setDeviceId(java.lang.String value) A device's ID.
void	setManifestOverridesPayload(CfnApplicationInstance.ManifestOverridesPayloadProperty value) Setting overrides for the application manifest.
void	setManifestOverridesPayload(IResolvable value) Setting overrides for the application manifest.
void	setManifestPayload(CfnApplicationInstance.ManifestPayloadProperty value) The application's manifest document.
void	setManifestPayload(IResolvable value) The application's manifest document.
void	setName(java.lang.String value) A name for the application instance.
void	setRuntimeRoleArn(java.lang.String value) The ARN of a runtime role for the application instance.
void	setStatusFilter(java.lang.String value) Only include instances with a specific status.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplicationInstance

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

CfnApplicationInstance

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

CfnApplicationInstance

public CfnApplicationInstance(Construct scope,
                              java.lang.String id,
                              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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApplicationInstanceId

public java.lang.String getAttrApplicationInstanceId()

The application instance's ID.

getAttrArn

public java.lang.String getAttrArn()

The application instance's ARN.

getAttrCreatedTime

public java.lang.Number getAttrCreatedTime()

The application instance's created time.

getAttrDefaultRuntimeContextDeviceName

public java.lang.String getAttrDefaultRuntimeContextDeviceName()

The application instance's default runtime context device name.

getAttrHealthStatus

public java.lang.String getAttrHealthStatus()

The application instance's health status.

getAttrLastUpdatedTime

public java.lang.Number getAttrLastUpdatedTime()

The application instance's last updated time.

getAttrStatus

public java.lang.String getAttrStatus()

The application instance's status.

getAttrStatusDescription

public java.lang.String getAttrStatusDescription()

The application instance's status description.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Tags for the application instance.

getDefaultRuntimeContextDevice

public java.lang.String getDefaultRuntimeContextDevice()

The device's ID.

setDefaultRuntimeContextDevice

public void setDefaultRuntimeContextDevice(java.lang.String value)

The device's ID.

getManifestPayload

public java.lang.Object getManifestPayload()

The application's manifest document.

setManifestPayload

public void setManifestPayload(CfnApplicationInstance.ManifestPayloadProperty value)

The application's manifest document.

setManifestPayload

public void setManifestPayload(IResolvable value)

The application's manifest document.

getApplicationInstanceIdToReplace

public java.lang.String getApplicationInstanceIdToReplace()

The ID of an application instance to replace with the new instance.

setApplicationInstanceIdToReplace

public void setApplicationInstanceIdToReplace(java.lang.String value)

The ID of an application instance to replace with the new instance.

getDescription

public java.lang.String getDescription()

A description for the application instance.

setDescription

public void setDescription(java.lang.String value)

A description for the application instance.

getDeviceId

public java.lang.String getDeviceId()

A device's ID.

setDeviceId

public void setDeviceId(java.lang.String value)

A device's ID.

getManifestOverridesPayload

public java.lang.Object getManifestOverridesPayload()

Setting overrides for the application manifest.

setManifestOverridesPayload

public void setManifestOverridesPayload(IResolvable value)

Setting overrides for the application manifest.

setManifestOverridesPayload

public void setManifestOverridesPayload(CfnApplicationInstance.ManifestOverridesPayloadProperty value)

Setting overrides for the application manifest.

getName

public java.lang.String getName()

A name for the application instance.

setName

public void setName(java.lang.String value)

A name for the application instance.

getRuntimeRoleArn

public java.lang.String getRuntimeRoleArn()

The ARN of a runtime role for the application instance.

setRuntimeRoleArn

public void setRuntimeRoleArn(java.lang.String value)

The ARN of a runtime role for the application instance.

getStatusFilter

public java.lang.String getStatusFilter()

Only include instances with a specific status.

setStatusFilter

public void setStatusFilter(java.lang.String value)

Only include instances with a specific status.