158 lines
6.4 KiB
TypeScript
158 lines
6.4 KiB
TypeScript
import * as cdk from "../../core/lib";
|
|
import * as constructs from "constructs";
|
|
import * as cfn_parse from "../../core/lib/helpers-internal";
|
|
import { IWorkflowDefinitionRef, WorkflowDefinitionReference } from "../../interfaces/generated/aws-novaact-interfaces.generated";
|
|
/**
|
|
* Definition of AWS::NovaAct::WorkflowDefinition Resource Type.
|
|
*
|
|
* @cloudformationResource AWS::NovaAct::WorkflowDefinition
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-novaact-workflowdefinition.html
|
|
*/
|
|
export declare class CfnWorkflowDefinition extends cdk.CfnResource implements cdk.IInspectable, IWorkflowDefinitionRef {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnWorkflowDefinition 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): CfnWorkflowDefinition;
|
|
/**
|
|
* Checks whether the given object is a CfnWorkflowDefinition
|
|
*/
|
|
static isCfnWorkflowDefinition(x: any): x is CfnWorkflowDefinition;
|
|
static arnForWorkflowDefinition(resource: IWorkflowDefinitionRef): string;
|
|
/**
|
|
* An optional description of the workflow definition's purpose and functionality.
|
|
*/
|
|
private _description?;
|
|
/**
|
|
* Configuration settings for exporting workflow execution data and logs to Amazon S3.
|
|
*/
|
|
private _exportConfig?;
|
|
/**
|
|
* The name of the workflow definition.
|
|
*/
|
|
private _name;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::NovaAct::WorkflowDefinition`.
|
|
*
|
|
* @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: CfnWorkflowDefinitionProps);
|
|
get workflowDefinitionRef(): WorkflowDefinitionReference;
|
|
/**
|
|
* An optional description of the workflow definition's purpose and functionality.
|
|
*/
|
|
get description(): string | undefined;
|
|
/**
|
|
* An optional description of the workflow definition's purpose and functionality.
|
|
*/
|
|
set description(value: string | undefined);
|
|
/**
|
|
* Configuration settings for exporting workflow execution data and logs to Amazon S3.
|
|
*/
|
|
get exportConfig(): cdk.IResolvable | CfnWorkflowDefinition.WorkflowExportConfigProperty | undefined;
|
|
/**
|
|
* Configuration settings for exporting workflow execution data and logs to Amazon S3.
|
|
*/
|
|
set exportConfig(value: cdk.IResolvable | CfnWorkflowDefinition.WorkflowExportConfigProperty | undefined);
|
|
/**
|
|
* The name of the workflow definition.
|
|
*/
|
|
get name(): string;
|
|
/**
|
|
* The name of the workflow definition.
|
|
*/
|
|
set name(value: string);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the workflow definition.
|
|
*
|
|
* @cloudformationAttribute Arn
|
|
*/
|
|
get attrArn(): string;
|
|
/**
|
|
* The timestamp when the workflow definition was created.
|
|
*
|
|
* @cloudformationAttribute CreatedAt
|
|
*/
|
|
get attrCreatedAt(): string;
|
|
/**
|
|
* The current status of the workflow definition.
|
|
*
|
|
* @cloudformationAttribute Status
|
|
*/
|
|
get attrStatus(): 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>;
|
|
}
|
|
export declare namespace CfnWorkflowDefinition {
|
|
/**
|
|
* Configuration settings for exporting workflow execution data and logs to Amazon S3.
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-novaact-workflowdefinition-workflowexportconfig.html
|
|
*/
|
|
interface WorkflowExportConfigProperty {
|
|
/**
|
|
* The name of the Amazon S3 bucket for exporting workflow data.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-novaact-workflowdefinition-workflowexportconfig.html#cfn-novaact-workflowdefinition-workflowexportconfig-s3bucketname
|
|
*/
|
|
readonly s3BucketName: string;
|
|
/**
|
|
* An optional prefix for Amazon S3 object keys to organize exported data.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-novaact-workflowdefinition-workflowexportconfig.html#cfn-novaact-workflowdefinition-workflowexportconfig-s3keyprefix
|
|
*/
|
|
readonly s3KeyPrefix?: string;
|
|
}
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnWorkflowDefinition`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-novaact-workflowdefinition.html
|
|
*/
|
|
export interface CfnWorkflowDefinitionProps {
|
|
/**
|
|
* An optional description of the workflow definition's purpose and functionality.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-novaact-workflowdefinition.html#cfn-novaact-workflowdefinition-description
|
|
*/
|
|
readonly description?: string;
|
|
/**
|
|
* Configuration settings for exporting workflow execution data and logs to Amazon S3.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-novaact-workflowdefinition.html#cfn-novaact-workflowdefinition-exportconfig
|
|
*/
|
|
readonly exportConfig?: cdk.IResolvable | CfnWorkflowDefinition.WorkflowExportConfigProperty;
|
|
/**
|
|
* The name of the workflow definition.
|
|
*
|
|
* Must be unique within your account and region.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-novaact-workflowdefinition.html#cfn-novaact-workflowdefinition-name
|
|
*/
|
|
readonly name: string;
|
|
}
|
|
export type { IWorkflowDefinitionRef, WorkflowDefinitionReference };
|