software.amazon.awscdk.services.iotfleethub

Class CfnApplication

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

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:40.027Z")
 @Stability(value=Stable)
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 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
	CfnApplication(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
String	getApplicationDescription() An optional description of the web application.
String	getApplicationName() The name of the web application.
String	getAttrApplicationArn() The ARN of the web application.
Number	getAttrApplicationCreationDate() The date (in Unix epoch time) when the web application was created.
String	getAttrApplicationId() The unique Id of the web application.
Number	getAttrApplicationLastUpdateDate() The date (in Unix epoch time) when the web application was last updated.
String	getAttrApplicationState() The current state of the web application.
String	getAttrApplicationUrl() The URL of the web application.
String	getAttrErrorMessage() A message that explains any failures included in the applicationState response field.
String	getAttrSsoClientId() The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
protected Map<String,Object>	getCfnProperties()
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationDescription(String value) An optional description of the web application.
void	setApplicationName(String value) The name of the web application.
void	setRoleArn(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.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

CfnApplication

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

CfnApplication

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

CfnApplication

@Stability(value=Stable)
public CfnApplication(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               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

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

getAttrApplicationArn

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

The ARN of the web application.

getAttrApplicationCreationDate

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

The date (in Unix epoch time) when the web application was created.

getAttrApplicationId

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

The unique Id of the web application.

getAttrApplicationLastUpdateDate

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

The date (in Unix epoch time) when the web application was last updated.

getAttrApplicationState

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

The current state of the web application.

getAttrApplicationUrl

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

The URL of the web application.

getAttrErrorMessage

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

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

The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

A set of key/value pairs that you can use to manage the web application resource.

getApplicationName

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

The name of the web application.

setApplicationName

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

The name of the web application.

getRoleArn

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

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

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

An optional description of the web application.

setApplicationDescription

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

An optional description of the web application.