Class CfnEnvironment
The AWS::MWAA::Environment
resource creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Inherited Members
Namespace: Amazon.CDK.AWS.MWAA
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEnvironment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html
CloudformationResource: AWS::MWAA::Environment
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.MWAA;
var airflowConfigurationOptions;
var tags;
var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
Name = "name",
// the properties below are optional
AirflowConfigurationOptions = airflowConfigurationOptions,
AirflowVersion = "airflowVersion",
DagS3Path = "dagS3Path",
EndpointManagement = "endpointManagement",
EnvironmentClass = "environmentClass",
ExecutionRoleArn = "executionRoleArn",
KmsKey = "kmsKey",
LoggingConfiguration = new LoggingConfigurationProperty {
DagProcessingLogs = new ModuleLoggingConfigurationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
Enabled = false,
LogLevel = "logLevel"
},
SchedulerLogs = new ModuleLoggingConfigurationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
Enabled = false,
LogLevel = "logLevel"
},
TaskLogs = new ModuleLoggingConfigurationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
Enabled = false,
LogLevel = "logLevel"
},
WebserverLogs = new ModuleLoggingConfigurationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
Enabled = false,
LogLevel = "logLevel"
},
WorkerLogs = new ModuleLoggingConfigurationProperty {
CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
Enabled = false,
LogLevel = "logLevel"
}
},
MaxWorkers = 123,
MinWorkers = 123,
NetworkConfiguration = new NetworkConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
},
PluginsS3ObjectVersion = "pluginsS3ObjectVersion",
PluginsS3Path = "pluginsS3Path",
RequirementsS3ObjectVersion = "requirementsS3ObjectVersion",
RequirementsS3Path = "requirementsS3Path",
Schedulers = 123,
SourceBucketArn = "sourceBucketArn",
StartupScriptS3ObjectVersion = "startupScriptS3ObjectVersion",
StartupScriptS3Path = "startupScriptS3Path",
Tags = tags,
WebserverAccessMode = "webserverAccessMode",
WeeklyMaintenanceWindowStart = "weeklyMaintenanceWindowStart"
});
Synopsis
Constructors
CfnEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEnvironment(Construct, String, ICfnEnvironmentProps) |
Properties
AirflowConfigurationOptions | A list of key-value pairs containing the Airflow configuration options for your environment. |
AirflowVersion | The version of Apache Airflow to use for the environment. |
AttrArn | The ARN for the Amazon MWAA environment. |
AttrCeleryExecutorQueue | The queue ARN for the environment's Celery Executor . Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC. |
AttrDatabaseVpcEndpointService | The VPC endpoint for the environment's Amazon RDS database. |
AttrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn | The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published. |
AttrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn | The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published. |
AttrLoggingConfigurationTaskLogsCloudWatchLogGroupArn | The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published. |
AttrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn | The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published. |
AttrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn | The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published. |
AttrWebserverUrl | The URL of your Apache Airflow UI. |
AttrWebserverVpcEndpointService | The VPC endpoint for the environment's web server. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DagS3Path | The relative path to the DAGs folder on your Amazon S3 bucket. |
EndpointManagement | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. |
EnvironmentClass | The environment class type. |
ExecutionRoleArn | The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. |
KmsKey | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. |
LoggingConfiguration | The Apache Airflow logs being sent to CloudWatch Logs: |
MaxWorkers | The maximum number of workers that you want to run in your environment. |
MinWorkers | The minimum number of workers that you want to run in your environment. |
Name | The name of your Amazon MWAA environment. |
NetworkConfiguration | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. |
PluginsS3ObjectVersion | The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins . |
PluginsS3Path | The relative path to the |
RequirementsS3ObjectVersion | The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies . |
RequirementsS3Path | The relative path to the |
Schedulers | The number of schedulers that you want to run in your environment. |
SourceBucketArn | The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. |
StartupScriptS3ObjectVersion | The version of the startup shell script in your Amazon S3 bucket. |
StartupScriptS3Path | The relative path to the startup shell script in your Amazon S3 bucket. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The key-value tag pairs associated to your environment. |
WebserverAccessMode | The Apache Airflow Web server access mode. |
WeeklyMaintenanceWindowStart | The day and time of the week to start weekly maintenance updates of your environment in the following format: |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEnvironment(Construct, String, ICfnEnvironmentProps)
public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEnvironmentProps
Resource properties.
Properties
AirflowConfigurationOptions
A list of key-value pairs containing the Airflow configuration options for your environment.
public virtual object AirflowConfigurationOptions { get; set; }
Property Value
System.Object
AirflowVersion
The version of Apache Airflow to use for the environment.
public virtual string AirflowVersion { get; set; }
Property Value
System.String
AttrArn
The ARN for the Amazon MWAA environment.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCeleryExecutorQueue
The queue ARN for the environment's Celery Executor . Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
public virtual string AttrCeleryExecutorQueue { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CeleryExecutorQueue
AttrDatabaseVpcEndpointService
The VPC endpoint for the environment's Amazon RDS database.
public virtual string AttrDatabaseVpcEndpointService { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DatabaseVpcEndpointService
AttrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
public virtual string AttrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LoggingConfiguration.DagProcessingLogs.CloudWatchLogGroupArn
AttrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
public virtual string AttrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LoggingConfiguration.SchedulerLogs.CloudWatchLogGroupArn
AttrLoggingConfigurationTaskLogsCloudWatchLogGroupArn
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
public virtual string AttrLoggingConfigurationTaskLogsCloudWatchLogGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LoggingConfiguration.TaskLogs.CloudWatchLogGroupArn
AttrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
public virtual string AttrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LoggingConfiguration.WebserverLogs.CloudWatchLogGroupArn
AttrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
public virtual string AttrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LoggingConfiguration.WorkerLogs.CloudWatchLogGroupArn
AttrWebserverUrl
The URL of your Apache Airflow UI.
public virtual string AttrWebserverUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: WebserverUrl
AttrWebserverVpcEndpointService
The VPC endpoint for the environment's web server.
public virtual string AttrWebserverVpcEndpointService { get; }
Property Value
System.String
Remarks
CloudformationAttribute: WebserverVpcEndpointService
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
DagS3Path
The relative path to the DAGs folder on your Amazon S3 bucket.
public virtual string DagS3Path { get; set; }
Property Value
System.String
EndpointManagement
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
public virtual string EndpointManagement { get; set; }
Property Value
System.String
EnvironmentClass
The environment class type.
public virtual string EnvironmentClass { get; set; }
Property Value
System.String
ExecutionRoleArn
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
public virtual string ExecutionRoleArn { get; set; }
Property Value
System.String
KmsKey
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
public virtual string KmsKey { get; set; }
Property Value
System.String
LoggingConfiguration
The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs
, SchedulerLogs
, TaskLogs
, WebserverLogs
, WorkerLogs
.
public virtual object LoggingConfiguration { get; set; }
Property Value
System.Object
MaxWorkers
The maximum number of workers that you want to run in your environment.
public virtual Nullable<double> MaxWorkers { get; set; }
Property Value
System.Nullable<System.Double>
MinWorkers
The minimum number of workers that you want to run in your environment.
public virtual Nullable<double> MinWorkers { get; set; }
Property Value
System.Nullable<System.Double>
Name
The name of your Amazon MWAA environment.
public virtual string Name { get; set; }
Property Value
System.String
NetworkConfiguration
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
public virtual object NetworkConfiguration { get; set; }
Property Value
System.Object
PluginsS3ObjectVersion
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
public virtual string PluginsS3ObjectVersion { get; set; }
Property Value
System.String
PluginsS3Path
The relative path to the plugins.zip
file on your Amazon S3 bucket. For example, plugins.zip
. To learn more, see Installing custom plugins .
public virtual string PluginsS3Path { get; set; }
Property Value
System.String
RequirementsS3ObjectVersion
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
public virtual string RequirementsS3ObjectVersion { get; set; }
Property Value
System.String
RequirementsS3Path
The relative path to the requirements.txt
file on your Amazon S3 bucket. For example, requirements.txt
. To learn more, see Installing Python dependencies .
public virtual string RequirementsS3Path { get; set; }
Property Value
System.String
Schedulers
The number of schedulers that you want to run in your environment.
public virtual Nullable<double> Schedulers { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid values:.
SourceBucketArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
public virtual string SourceBucketArn { get; set; }
Property Value
System.String
StartupScriptS3ObjectVersion
The version of the startup shell script in your Amazon S3 bucket.
public virtual string StartupScriptS3ObjectVersion { get; set; }
Property Value
System.String
StartupScriptS3Path
The relative path to the startup shell script in your Amazon S3 bucket.
public virtual string StartupScriptS3Path { get; set; }
Property Value
System.String
Remarks
For example, s3://mwaa-environment/startup.sh
.
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The key-value tag pairs associated to your environment.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Remarks
For example, "Environment": "Staging"
. To learn more, see Tagging .
WebserverAccessMode
The Apache Airflow Web server access mode.
public virtual string WebserverAccessMode { get; set; }
Property Value
System.String
WeeklyMaintenanceWindowStart
The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM
.
public virtual string WeeklyMaintenanceWindowStart { get; set; }
Property Value
System.String
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>