CfnApplication

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.iotfleethub.CfnApplication

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.998Z")
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTFleetHub::Application`.

Represents a Fleet Hub for AWS IoT Device Management web application.

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.iotfleethub.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .applicationName("applicationName")
         .roleArn("roleArn")
         // the properties below are optional
         .applicationDescription("applicationDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnApplication.Builder
A fluent builder for CfnApplication.
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnApplication.Builder` A fluent builder for `CfnApplication`.

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.

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
	`CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps props)` Create a new `AWS::IoTFleetHub::Application`.
`protected`	`CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApplicationDescription()` An optional description of the web application.
`java.lang.String`	`getApplicationName()` The name of the web application.
`java.lang.String`	`getAttrApplicationArn()` The ARN of the web application.
`java.lang.Number`	`getAttrApplicationCreationDate()` The date (in Unix epoch time) when the web application was created.
`java.lang.String`	`getAttrApplicationId()` The unique Id of the web application.
`java.lang.Number`	`getAttrApplicationLastUpdateDate()` The date (in Unix epoch time) when the web application was last updated.
`java.lang.String`	`getAttrApplicationState()` The current state of the web application.
`java.lang.String`	`getAttrApplicationUrl()` The URL of the web application.
`java.lang.String`	`getAttrErrorMessage()` A message that explains any failures included in the applicationState response field.
`java.lang.String`	`getAttrSsoClientId()` The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getRoleArn()` The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
`TagManager`	`getTags()` A set of key/value pairs that you can use to manage the web application resource.
`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`	`setApplicationDescription(java.lang.String value)` An optional description of the web application.
`void`	`setApplicationName(java.lang.String value)` The name of the web application.
`void`	`setRoleArn(java.lang.String value)` The ARN of the role that the web application assumes when it interacts with AWS IoT Core .

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
  - CfnApplication
```
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnApplication
```
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnApplication
```
public CfnApplication(Construct scope,
                      java.lang.String id,
                      CfnApplicationProps props)
```
    Create a new `AWS::IoTFleetHub::Application`.
    
    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.
  - getAttrApplicationArn
```
public java.lang.String getAttrApplicationArn()
```
    The ARN of the web application.
  - getAttrApplicationCreationDate
```
public java.lang.Number getAttrApplicationCreationDate()
```
    The date (in Unix epoch time) when the web application was created.
  - getAttrApplicationId
```
public java.lang.String getAttrApplicationId()
```
    The unique Id of the web application.
  - getAttrApplicationLastUpdateDate
```
public java.lang.Number getAttrApplicationLastUpdateDate()
```
    The date (in Unix epoch time) when the web application was last updated.
  - getAttrApplicationState
```
public java.lang.String getAttrApplicationState()
```
    The current state of the web application.
  - getAttrApplicationUrl
```
public java.lang.String getAttrApplicationUrl()
```
    The URL of the web application.
  - getAttrErrorMessage
```
public java.lang.String getAttrErrorMessage()
```
    A message that explains any failures included in the applicationState response field.
    This message explains failures in the CreateApplication and DeleteApplication actions.
  - getAttrSsoClientId
```
public java.lang.String getAttrSsoClientId()
```
    The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    A set of key/value pairs that you can use to manage the web application resource.
  - getApplicationName
```
public java.lang.String getApplicationName()
```
    The name of the web application.
  - setApplicationName
```
public void setApplicationName(java.lang.String value)
```
    The name of the web application.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
    
    The name of the role must be in the form FleetHub_random_string .
    
    Pattern: ^arn:[!-~]+$
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
    
    The name of the role must be in the form FleetHub_random_string .
    
    Pattern: ^arn:[!-~]+$
  - getApplicationDescription
```
public java.lang.String getApplicationDescription()
```
    An optional description of the web application.
  - setApplicationDescription
```
public void setApplicationDescription(java.lang.String value)
```
    An optional description of the web application.

Class CfnApplication

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnApplication

CfnApplication

CfnApplication

Method Detail

inspect

renderProperties

getAttrApplicationArn

getAttrApplicationCreationDate

getAttrApplicationId

getAttrApplicationLastUpdateDate

getAttrApplicationState

getAttrApplicationUrl

getAttrErrorMessage

getAttrSsoClientId

getCfnProperties

getTags

getApplicationName

setApplicationName

getRoleArn

setRoleArn

getApplicationDescription

setApplicationDescription