software.amazon.awscdk.services.panorama

Class CfnApplicationInstance

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.panorama.CfnApplicationInstance

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.169Z")
 @Stability(value=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();
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplicationInstance(software.constructs.Construct scope, 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
String	getApplicationInstanceIdToReplace() The ID of an application instance to replace with the new instance.
String	getAttrApplicationInstanceId() The application instance's ID.
String	getAttrArn() The application instance's ARN.
Number	getAttrCreatedTime() The application instance's created time.
String	getAttrDefaultRuntimeContextDeviceName() The application instance's default runtime context device name.
String	getAttrHealthStatus() The application instance's health status.
Number	getAttrLastUpdatedTime() The application instance's last updated time.
String	getAttrStatus() The application instance's status.
String	getAttrStatusDescription() The application instance's status description.
protected Map<String,Object>	getCfnProperties()
String	getDefaultRuntimeContextDevice() The device's ID.
String	getDescription() A description for the application instance.
String	getDeviceId() A device's ID.
Object	getManifestOverridesPayload() Setting overrides for the application manifest.
Object	getManifestPayload() The application's manifest document.
String	getName() A name for the application instance.
String	getRuntimeRoleArn() The ARN of a runtime role for the application instance.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationInstanceIdToReplace(String value) The ID of an application instance to replace with the new instance.
void	setDefaultRuntimeContextDevice(String value) The device's ID.
void	setDescription(String value) A description for the application instance.
void	setDeviceId(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(String value) A name for the application instance.
void	setRuntimeRoleArn(String value) The ARN of a runtime role for the application instance.
void	setStatusFilter(String value) Only include instances with a specific status.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnApplicationInstance(@NotNull
                                                       software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrApplicationInstanceId()

The application instance's ID.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The application instance's ARN.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public Number getAttrCreatedTime()

The application instance's created time.

getAttrDefaultRuntimeContextDeviceName

@Stability(value=Stable)
 @NotNull
public String getAttrDefaultRuntimeContextDeviceName()

The application instance's default runtime context device name.

getAttrHealthStatus

@Stability(value=Stable)
 @NotNull
public String getAttrHealthStatus()

The application instance's health status.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public Number getAttrLastUpdatedTime()

The application instance's last updated time.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The application instance's status.

getAttrStatusDescription

@Stability(value=Stable)
 @NotNull
public String getAttrStatusDescription()

The application instance's status description.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Tags for the application instance.

getDefaultRuntimeContextDevice

@Stability(value=Stable)
 @NotNull
public String getDefaultRuntimeContextDevice()

The device's ID.

setDefaultRuntimeContextDevice

@Stability(value=Stable)
public void setDefaultRuntimeContextDevice(@NotNull
                                                                    String value)

The device's ID.

getManifestPayload

@Stability(value=Stable)
 @NotNull
public Object getManifestPayload()

The application's manifest document.

setManifestPayload

@Stability(value=Stable)
public void setManifestPayload(@NotNull
                                                        CfnApplicationInstance.ManifestPayloadProperty value)

The application's manifest document.

setManifestPayload

@Stability(value=Stable)
public void setManifestPayload(@NotNull
                                                        IResolvable value)

The application's manifest document.

getApplicationInstanceIdToReplace

@Stability(value=Stable)
 @Nullable
public String getApplicationInstanceIdToReplace()

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

setApplicationInstanceIdToReplace

@Stability(value=Stable)
public void setApplicationInstanceIdToReplace(@Nullable
                                                                       String value)

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the application instance.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the application instance.

getDeviceId

@Stability(value=Stable)
 @Nullable
public String getDeviceId()

A device's ID.

setDeviceId

@Stability(value=Stable)
public void setDeviceId(@Nullable
                                                 String value)

A device's ID.

getManifestOverridesPayload

@Stability(value=Stable)
 @Nullable
public Object getManifestOverridesPayload()

Setting overrides for the application manifest.

setManifestOverridesPayload

@Stability(value=Stable)
public void setManifestOverridesPayload(@Nullable
                                                                 CfnApplicationInstance.ManifestOverridesPayloadProperty value)

Setting overrides for the application manifest.

setManifestOverridesPayload

@Stability(value=Stable)
public void setManifestOverridesPayload(@Nullable
                                                                 IResolvable value)

Setting overrides for the application manifest.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

A name for the application instance.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

A name for the application instance.

getRuntimeRoleArn

@Stability(value=Stable)
 @Nullable
public String getRuntimeRoleArn()

The ARN of a runtime role for the application instance.

setRuntimeRoleArn

@Stability(value=Stable)
public void setRuntimeRoleArn(@Nullable
                                                       String value)

The ARN of a runtime role for the application instance.

getStatusFilter

@Stability(value=Stable)
 @Nullable
public String getStatusFilter()

Only include instances with a specific status.

setStatusFilter

@Stability(value=Stable)
public void setStatusFilter(@Nullable
                                                     String value)

Only include instances with a specific status.