Class CfnApplication
Represents a Fleet Hub for AWS IoT Device Management web application.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTFleetHub
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApplication : CfnResource, IInspectable, IApplicationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnApplication Inherits CfnResource Implements IInspectable, IApplicationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
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 |
Properties
| ApplicationDescription | An optional description of the web application. |
| ApplicationName | The name of the web application. |
| ApplicationRef | A reference to a Application resource. |
| 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 | Represents a Fleet Hub for AWS IoT Device Management web application. |
| CfnPropertyNames | Represents a Fleet Hub for AWS IoT Device Management web application. |
| RoleArn | The ARN of the role that the web application assumes when it interacts with AWS IoT Core . |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | A set of key/value pairs that you can use to manage the web application resource. |
Methods
| ArnForApplication(IApplicationRef) | Represents a Fleet Hub for AWS IoT Device Management web application. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnApplication(object) | Checks whether the given object is a CfnApplication. |
| RenderProperties(IDictionary<string, object>) | Represents a Fleet Hub for AWS IoT Device Management web application. |
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 string
Construct identifier for this resource (unique in its scope).
- props ICfnApplicationProps
Resource properties.
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
Properties
ApplicationDescription
An optional description of the web application.
public virtual string? ApplicationDescription { get; set; }
Property Value
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
ApplicationName
The name of the web application.
public virtual string ApplicationName { get; set; }
Property Value
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
ApplicationRef
A reference to a Application resource.
public virtual IApplicationReference ApplicationRef { get; }
Property Value
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
AttrApplicationArn
The ARN of the web application.
public virtual string AttrApplicationArn { get; }
Property Value
Remarks
CloudformationAttribute: ApplicationArn
AttrApplicationCreationDate
The date (in Unix epoch time) when the web application was created.
public virtual double AttrApplicationCreationDate { get; }
Property Value
Remarks
CloudformationAttribute: ApplicationCreationDate
AttrApplicationId
The unique Id of the web application.
public virtual string AttrApplicationId { get; }
Property Value
Remarks
CloudformationAttribute: ApplicationId
AttrApplicationLastUpdateDate
The date (in Unix epoch time) when the web application was last updated.
public virtual double AttrApplicationLastUpdateDate { get; }
Property Value
Remarks
CloudformationAttribute: ApplicationLastUpdateDate
AttrApplicationState
The current state of the web application.
public virtual string AttrApplicationState { get; }
Property Value
Remarks
CloudformationAttribute: ApplicationState
AttrApplicationUrl
The URL of the web application.
public virtual string AttrApplicationUrl { get; }
Property Value
Remarks
CloudformationAttribute: ApplicationUrl
AttrErrorMessage
A message that explains any failures included in the applicationState response field.
public virtual string AttrErrorMessage { get; }
Property Value
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
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
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
CfnProperties
Represents a Fleet Hub for AWS IoT Device Management web application.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
CfnPropertyNames
Represents a Fleet Hub for AWS IoT Device Management web application.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
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
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
TagsRaw
A set of key/value pairs that you can use to manage the web application resource.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
Methods
ArnForApplication(IApplicationRef)
Represents a Fleet Hub for AWS IoT Device Management web application.
public static string ArnForApplication(IApplicationRef resource)
Parameters
- resource IApplicationRef
Returns
Remarks
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"
} }
});
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.
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
IsCfnApplication(object)
Checks whether the given object is a CfnApplication.
public static bool IsCfnApplication(object x)
Parameters
- x object
Returns
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Represents a Fleet Hub for AWS IoT Device Management web application.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::IoTFleetHub::Application
ExampleMetadata: fixture=_generated