Package software.amazon.awscdk.services.iotfleethub

Class CfnApplication

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.iotfleethub.CfnApplication
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:29:57.829Z") @Stability(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();

  • 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

    • CfnApplication

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

    • CfnApplication

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

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull 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 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.

    • getAttrApplicationArn

      @Stability(Stable) @NotNull public String getAttrApplicationArn()
      The ARN of the web application.

    • getAttrApplicationCreationDate

      @Stability(Stable) @NotNull public Number getAttrApplicationCreationDate()
      The date (in Unix epoch time) when the web application was created.

    • getAttrApplicationId

      @Stability(Stable) @NotNull public String getAttrApplicationId()
      The unique Id of the web application.

    • getAttrApplicationLastUpdateDate

      @Stability(Stable) @NotNull public Number getAttrApplicationLastUpdateDate()
      The date (in Unix epoch time) when the web application was last updated.

    • getAttrApplicationState

      @Stability(Stable) @NotNull public String getAttrApplicationState()
      The current state of the web application.

    • getAttrApplicationUrl

      @Stability(Stable) @NotNull public String getAttrApplicationUrl()
      The URL of the web application.

    • getAttrErrorMessage

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A set of key/value pairs that you can use to manage the web application resource.

    • getApplicationName

      @Stability(Stable) @NotNull public String getApplicationName()
      The name of the web application.

    • setApplicationName

      @Stability(Stable) public void setApplicationName(@NotNull String value)
      The name of the web application.

    • getRoleArn

      @Stability(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(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(Stable) @Nullable public String getApplicationDescription()
      An optional description of the web application.

    • setApplicationDescription

      @Stability(Stable) public void setApplicationDescription(@Nullable String value)
      An optional description of the web application.