Class CfnApplication
A CloudFormation AWS::IoTFleetHub::Application
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTFleetHub
Assembly: Amazon.CDK.AWS.IoTFleetHub.dll
Syntax (csharp)
public class CfnApplication : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApplication
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Represents a Fleet Hub for AWS IoT Device Management web application.
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTFleetHub;
var cfnApplication = new CfnApplication(this, "MyCfnApplication", new CfnApplicationProps {
ApplicationName = "applicationName",
RoleArn = "roleArn",
// the properties below are optional
ApplicationDescription = "applicationDescription",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnApplication(Construct, String, ICfnApplicationProps) | Create a new |
CfnApplication(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplication(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApplicationDescription | An optional description of the web application. |
ApplicationName | The name of the web application. |
AttrApplicationArn | The ARN of the web application. |
AttrApplicationCreationDate | The date (in Unix epoch time) when the web application was created. |
AttrApplicationId | The unique Id of the web application. |
AttrApplicationLastUpdateDate | The date (in Unix epoch time) when the web application was last updated. |
AttrApplicationState | The current state of the web application. |
AttrApplicationUrl | The URL of the web application. |
AttrErrorMessage | A message that explains any failures included in the applicationState response field. |
AttrSsoClientId | The Id of the single sign-on client that you use to authenticate and authorize users on the web application. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
RoleArn | The ARN of the role that the web application assumes when it interacts with AWS IoT Core . |
Tags | A set of key/value pairs that you can use to manage the web application resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplication(Construct, String, ICfnApplicationProps)
Create a new AWS::IoTFleetHub::Application
.
public CfnApplication(Construct scope, string id, ICfnApplicationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApplicationProps
- resource properties.
CfnApplication(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplication(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplication(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplication(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApplicationDescription
An optional description of the web application.
public virtual string ApplicationDescription { get; set; }
Property Value
System.String
Remarks
ApplicationName
The name of the web application.
public virtual string ApplicationName { get; set; }
Property Value
System.String
Remarks
AttrApplicationArn
The ARN of the web application.
public virtual string AttrApplicationArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationArn
AttrApplicationCreationDate
The date (in Unix epoch time) when the web application was created.
public virtual double AttrApplicationCreationDate { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: ApplicationCreationDate
AttrApplicationId
The unique Id of the web application.
public virtual string AttrApplicationId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationId
AttrApplicationLastUpdateDate
The date (in Unix epoch time) when the web application was last updated.
public virtual double AttrApplicationLastUpdateDate { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: ApplicationLastUpdateDate
AttrApplicationState
The current state of the web application.
public virtual string AttrApplicationState { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationState
AttrApplicationUrl
The URL of the web application.
public virtual string AttrApplicationUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationUrl
AttrErrorMessage
A message that explains any failures included in the applicationState response field.
public virtual string AttrErrorMessage { get; }
Property Value
System.String
Remarks
This message explains failures in the CreateApplication
and DeleteApplication
actions.
CloudformationAttribute: ErrorMessage
AttrSsoClientId
The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
public virtual string AttrSsoClientId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SsoClientId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
RoleArn
The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
The name of the role must be in the form FleetHub_random_string
.
Pattern: ^arn:[!-~]+$
Tags
A set of key/value pairs that you can use to manage the web application resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>