189 lines
6.8 KiB
TypeScript
189 lines
6.8 KiB
TypeScript
import * as cdk from "../../core/lib";
|
|
import * as constructs from "constructs";
|
|
import * as cfn_parse from "../../core/lib/helpers-internal";
|
|
import { ApplicationReference, IApplicationRef } from "../../interfaces/generated/aws-iotfleethub-interfaces.generated";
|
|
/**
|
|
* Represents a Fleet Hub for AWS IoT Device Management web application.
|
|
*
|
|
* @cloudformationResource AWS::IoTFleetHub::Application
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleethub-application.html
|
|
*/
|
|
export declare class CfnApplication extends cdk.CfnResource implements cdk.IInspectable, IApplicationRef, cdk.ITaggable {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnApplication from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApplication;
|
|
/**
|
|
* Checks whether the given object is a CfnApplication
|
|
*/
|
|
static isCfnApplication(x: any): x is CfnApplication;
|
|
static arnForApplication(resource: IApplicationRef): string;
|
|
/**
|
|
* An optional description of the web application.
|
|
*/
|
|
private _applicationDescription?;
|
|
/**
|
|
* The name of the web application.
|
|
*/
|
|
private _applicationName;
|
|
/**
|
|
* The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
|
|
*/
|
|
private _roleArn;
|
|
/**
|
|
* Tag Manager which manages the tags for this resource
|
|
*/
|
|
readonly tags: cdk.TagManager;
|
|
/**
|
|
* A set of key/value pairs that you can use to manage the web application resource.
|
|
*/
|
|
private _tagsRaw?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::IoTFleetHub::Application`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props: CfnApplicationProps);
|
|
get applicationRef(): ApplicationReference;
|
|
/**
|
|
* An optional description of the web application.
|
|
*/
|
|
get applicationDescription(): string | undefined;
|
|
/**
|
|
* An optional description of the web application.
|
|
*/
|
|
set applicationDescription(value: string | undefined);
|
|
/**
|
|
* The name of the web application.
|
|
*/
|
|
get applicationName(): string;
|
|
/**
|
|
* The name of the web application.
|
|
*/
|
|
set applicationName(value: string);
|
|
/**
|
|
* The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
|
|
*/
|
|
get roleArn(): string;
|
|
/**
|
|
* The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
|
|
*/
|
|
set roleArn(value: string);
|
|
/**
|
|
* A set of key/value pairs that you can use to manage the web application resource.
|
|
*/
|
|
get tagsRaw(): Array<cdk.CfnTag> | undefined;
|
|
/**
|
|
* A set of key/value pairs that you can use to manage the web application resource.
|
|
*/
|
|
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
|
|
/**
|
|
* The ARN of the web application.
|
|
*
|
|
* @cloudformationAttribute ApplicationArn
|
|
*/
|
|
get attrApplicationArn(): string;
|
|
/**
|
|
* The date (in Unix epoch time) when the web application was created.
|
|
*
|
|
* @cloudformationAttribute ApplicationCreationDate
|
|
*/
|
|
get attrApplicationCreationDate(): number;
|
|
/**
|
|
* The unique Id of the web application.
|
|
*
|
|
* @cloudformationAttribute ApplicationId
|
|
*/
|
|
get attrApplicationId(): string;
|
|
/**
|
|
* The date (in Unix epoch time) when the web application was last updated.
|
|
*
|
|
* @cloudformationAttribute ApplicationLastUpdateDate
|
|
*/
|
|
get attrApplicationLastUpdateDate(): number;
|
|
/**
|
|
* The current state of the web application.
|
|
*
|
|
* @cloudformationAttribute ApplicationState
|
|
*/
|
|
get attrApplicationState(): string;
|
|
/**
|
|
* The URL of the web application.
|
|
*
|
|
* @cloudformationAttribute ApplicationUrl
|
|
*/
|
|
get attrApplicationUrl(): string;
|
|
/**
|
|
* A message that explains any failures included in the applicationState response field. This message explains failures in the `CreateApplication` and `DeleteApplication` actions.
|
|
*
|
|
* @cloudformationAttribute ErrorMessage
|
|
*/
|
|
get attrErrorMessage(): string;
|
|
/**
|
|
* The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
|
|
*
|
|
* @cloudformationAttribute SsoClientId
|
|
*/
|
|
get attrSsoClientId(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnApplication`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleethub-application.html
|
|
*/
|
|
export interface CfnApplicationProps {
|
|
/**
|
|
* An optional description of the web application.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleethub-application.html#cfn-iotfleethub-application-applicationdescription
|
|
*/
|
|
readonly applicationDescription?: string;
|
|
/**
|
|
* The name of the web application.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleethub-application.html#cfn-iotfleethub-application-applicationname
|
|
*/
|
|
readonly applicationName: string;
|
|
/**
|
|
* 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:[!-~]+$`
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleethub-application.html#cfn-iotfleethub-application-rolearn
|
|
*/
|
|
readonly roleArn: string;
|
|
/**
|
|
* A set of key/value pairs that you can use to manage the web application resource.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleethub-application.html#cfn-iotfleethub-application-tags
|
|
*/
|
|
readonly tags?: Array<cdk.CfnTag>;
|
|
}
|
|
export type { IApplicationRef, ApplicationReference };
|