aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
211 lines (210 loc) • 9.52 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { IWorkflowRef, WorkflowReference } from "../../interfaces/generated/aws-mwaaserverless-interfaces.generated";
/**
* Resource Type definition for AWS::MWAAServerless::Workflow resource.
*
* @cloudformationResource AWS::MWAAServerless::Workflow
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html
*/
export declare class CfnWorkflow extends cdk.CfnResource implements cdk.IInspectable, IWorkflowRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnWorkflow 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): CfnWorkflow;
/**
* Checks whether the given object is a CfnWorkflow
*/
static isCfnWorkflow(x: any): x is CfnWorkflow;
static arnForWorkflow(resource: IWorkflowRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
definitionS3Location: cdk.IResolvable | CfnWorkflow.S3LocationProperty;
description?: string;
encryptionConfiguration?: CfnWorkflow.EncryptionConfigurationProperty | cdk.IResolvable;
loggingConfiguration?: cdk.IResolvable | CfnWorkflow.LoggingConfigurationProperty;
name?: string;
networkConfiguration?: cdk.IResolvable | CfnWorkflow.NetworkConfigurationProperty;
roleArn: string;
/**
* A map of key-value pairs to be applied as tags.
*/
tags?: Record<string, string>;
triggerMode?: string;
/**
* Create a new `AWS::MWAAServerless::Workflow`.
*
* @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: CfnWorkflowProps);
get workflowRef(): WorkflowReference;
/**
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* @cloudformationAttribute ModifiedAt
*/
get attrModifiedAt(): string;
/**
* @cloudformationAttribute ScheduleConfiguration
*/
get attrScheduleConfiguration(): cdk.IResolvable;
/**
* @cloudformationAttribute WorkflowArn
*/
get attrWorkflowArn(): string;
/**
* @cloudformationAttribute WorkflowStatus
*/
get attrWorkflowStatus(): string;
/**
* @cloudformationAttribute WorkflowVersion
*/
get attrWorkflowVersion(): 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 CfnWorkflow {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-s3location.html
*/
interface S3LocationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-s3location.html#cfn-mwaaserverless-workflow-s3location-bucket
*/
readonly bucket: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-s3location.html#cfn-mwaaserverless-workflow-s3location-objectkey
*/
readonly objectKey: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-s3location.html#cfn-mwaaserverless-workflow-s3location-versionid
*/
readonly versionId?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-encryptionconfiguration.html
*/
interface EncryptionConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-encryptionconfiguration.html#cfn-mwaaserverless-workflow-encryptionconfiguration-kmskeyid
*/
readonly kmsKeyId?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-encryptionconfiguration.html#cfn-mwaaserverless-workflow-encryptionconfiguration-type
*/
readonly type: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-loggingconfiguration.html
*/
interface LoggingConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-loggingconfiguration.html#cfn-mwaaserverless-workflow-loggingconfiguration-loggroupname
*/
readonly logGroupName: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-networkconfiguration.html
*/
interface NetworkConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-networkconfiguration.html#cfn-mwaaserverless-workflow-networkconfiguration-securitygroupids
*/
readonly securityGroupIds?: Array<string>;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-networkconfiguration.html#cfn-mwaaserverless-workflow-networkconfiguration-subnetids
*/
readonly subnetIds?: Array<string>;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-scheduleconfiguration.html
*/
interface ScheduleConfigurationProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaaserverless-workflow-scheduleconfiguration.html#cfn-mwaaserverless-workflow-scheduleconfiguration-cronexpression
*/
readonly cronExpression?: string;
}
}
/**
* Properties for defining a `CfnWorkflow`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html
*/
export interface CfnWorkflowProps {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-definitions3location
*/
readonly definitionS3Location: cdk.IResolvable | CfnWorkflow.S3LocationProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-description
*/
readonly description?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-encryptionconfiguration
*/
readonly encryptionConfiguration?: CfnWorkflow.EncryptionConfigurationProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-loggingconfiguration
*/
readonly loggingConfiguration?: cdk.IResolvable | CfnWorkflow.LoggingConfigurationProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-name
*/
readonly name?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-networkconfiguration
*/
readonly networkConfiguration?: cdk.IResolvable | CfnWorkflow.NetworkConfigurationProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-rolearn
*/
readonly roleArn: string;
/**
* A map of key-value pairs to be applied as tags.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-tags
*/
readonly tags?: Record<string, string>;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaaserverless-workflow.html#cfn-mwaaserverless-workflow-triggermode
*/
readonly triggerMode?: string;
}
export type { IWorkflowRef, WorkflowReference };