awsmwaa

package
v2.151.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::MWAA Construct Library

This module is part of the AWS Cloud Development Kit project.

import mwaa "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::MWAA.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME

func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string

func CfnEnvironment_IsCfnElement

func CfnEnvironment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEnvironment_IsCfnResource

func CfnEnvironment_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnEnvironment_IsConstruct

func CfnEnvironment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnEnvironment_Override

func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)

Types

type CfnEnvironment

type CfnEnvironment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	awscdk.ITaggable
	// A list of key-value pairs containing the Airflow configuration options for your environment.
	AirflowConfigurationOptions() interface{}
	SetAirflowConfigurationOptions(val interface{})
	// The version of Apache Airflow to use for the environment.
	AirflowVersion() *string
	SetAirflowVersion(val *string)
	// The ARN for the Amazon MWAA environment.
	AttrArn() *string
	// The queue ARN for the environment's [Celery Executor](https://docs.aws.amazon.com/https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html) . 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.
	AttrCeleryExecutorQueue() *string
	// The VPC endpoint for the environment's Amazon RDS database.
	AttrDatabaseVpcEndpointService() *string
	// The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
	AttrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn() *string
	// The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
	AttrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn() *string
	// The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
	AttrLoggingConfigurationTaskLogsCloudWatchLogGroupArn() *string
	// The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
	AttrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn() *string
	// The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
	AttrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn() *string
	// The URL of your Apache Airflow UI.
	AttrWebserverUrl() *string
	// The VPC endpoint for the environment's web server.
	AttrWebserverVpcEndpointService() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The relative path to the DAGs folder on your Amazon S3 bucket.
	DagS3Path() *string
	SetDagS3Path(val *string)
	// Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
	EndpointManagement() *string
	SetEndpointManagement(val *string)
	// The environment class type.
	EnvironmentClass() *string
	SetEnvironmentClass(val *string)
	// The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	// The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
	KmsKey() *string
	SetKmsKey(val *string)
	// The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
	LoggingConfiguration() interface{}
	SetLoggingConfiguration(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The maximum number of web servers that you want to run in your environment.
	MaxWebservers() *float64
	SetMaxWebservers(val *float64)
	// The maximum number of workers that you want to run in your environment.
	MaxWorkers() *float64
	SetMaxWorkers(val *float64)
	// The minimum number of web servers that you want to run in your environment.
	MinWebservers() *float64
	SetMinWebservers(val *float64)
	// The minimum number of workers that you want to run in your environment.
	MinWorkers() *float64
	SetMinWorkers(val *float64)
	// The name of your Amazon MWAA environment.
	Name() *string
	SetName(val *string)
	// The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
	NetworkConfiguration() interface{}
	SetNetworkConfiguration(val interface{})
	// The tree node.
	Node() constructs.Node
	// The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
	PluginsS3ObjectVersion() *string
	SetPluginsS3ObjectVersion(val *string)
	// The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
	PluginsS3Path() *string
	SetPluginsS3Path(val *string)
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
	RequirementsS3ObjectVersion() *string
	SetRequirementsS3ObjectVersion(val *string)
	// The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
	RequirementsS3Path() *string
	SetRequirementsS3Path(val *string)
	// The number of schedulers that you want to run in your environment.
	//
	// Valid values:.
	Schedulers() *float64
	SetSchedulers(val *float64)
	// The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
	SourceBucketArn() *string
	SetSourceBucketArn(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The version of the startup shell script in your Amazon S3 bucket.
	StartupScriptS3ObjectVersion() *string
	SetStartupScriptS3ObjectVersion(val *string)
	// The relative path to the startup shell script in your Amazon S3 bucket.
	//
	// For example, `s3://mwaa-environment/startup.sh` .
	StartupScriptS3Path() *string
	SetStartupScriptS3Path(val *string)
	// Tag Manager which manages the tags for this resource.
	Tags() awscdk.TagManager
	// The key-value tag pairs associated to your environment.
	//
	// For example, `"Environment": "Staging"` . To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	TagsRaw() interface{}
	SetTagsRaw(val interface{})
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The Apache Airflow *Web server* access mode.
	WebserverAccessMode() *string
	SetWebserverAccessMode(val *string)
	// The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .
	WeeklyMaintenanceWindowStart() *string
	SetWeeklyMaintenanceWindowStart(val *string)
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

The `AWS::MWAA::Environment` resource creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var airflowConfigurationOptions interface{}
var tags interface{}

cfnEnvironment := awscdk.Aws_mwaa.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{
	Name: jsii.String("name"),

	// the properties below are optional
	AirflowConfigurationOptions: airflowConfigurationOptions,
	AirflowVersion: jsii.String("airflowVersion"),
	DagS3Path: jsii.String("dagS3Path"),
	EndpointManagement: jsii.String("endpointManagement"),
	EnvironmentClass: jsii.String("environmentClass"),
	ExecutionRoleArn: jsii.String("executionRoleArn"),
	KmsKey: jsii.String("kmsKey"),
	LoggingConfiguration: &LoggingConfigurationProperty{
		DagProcessingLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		SchedulerLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		TaskLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		WebserverLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		WorkerLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
	},
	MaxWebservers: jsii.Number(123),
	MaxWorkers: jsii.Number(123),
	MinWebservers: jsii.Number(123),
	MinWorkers: jsii.Number(123),
	NetworkConfiguration: &NetworkConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
	PluginsS3ObjectVersion: jsii.String("pluginsS3ObjectVersion"),
	PluginsS3Path: jsii.String("pluginsS3Path"),
	RequirementsS3ObjectVersion: jsii.String("requirementsS3ObjectVersion"),
	RequirementsS3Path: jsii.String("requirementsS3Path"),
	Schedulers: jsii.Number(123),
	SourceBucketArn: jsii.String("sourceBucketArn"),
	StartupScriptS3ObjectVersion: jsii.String("startupScriptS3ObjectVersion"),
	StartupScriptS3Path: jsii.String("startupScriptS3Path"),
	Tags: tags,
	WebserverAccessMode: jsii.String("webserverAccessMode"),
	WeeklyMaintenanceWindowStart: jsii.String("weeklyMaintenanceWindowStart"),
})

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html

func NewCfnEnvironment

func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment

type CfnEnvironmentProps

type CfnEnvironmentProps struct {
	// The name of your Amazon MWAA environment.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name
	//
	Name *string `field:"required" json:"name" yaml:"name"`
	// A list of key-value pairs containing the Airflow configuration options for your environment.
	//
	// For example, `core.default_timezone: utc` . To learn more, see [Apache Airflow configuration options](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions
	//
	AirflowConfigurationOptions interface{} `field:"optional" json:"airflowConfigurationOptions" yaml:"airflowConfigurationOptions"`
	// The version of Apache Airflow to use for the environment.
	//
	// If no value is specified, defaults to the latest version.
	//
	// If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
	//
	// *Allowed Values* : `1.10.12` | `2.0.2` | `2.2.2` | `2.4.3` | `2.5.1` | `2.6.3` | `2.7.2` | `2.8.1` | `2.9.2` (latest)
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion
	//
	AirflowVersion *string `field:"optional" json:"airflowVersion" yaml:"airflowVersion"`
	// The relative path to the DAGs folder on your Amazon S3 bucket.
	//
	// For example, `dags` . To learn more, see [Adding or updating DAGs](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path
	//
	DagS3Path *string `field:"optional" json:"dagS3Path" yaml:"dagS3Path"`
	// Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
	//
	// If set to `SERVICE` , Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to `CUSTOMER` , you must create, and manage, the VPC endpoints in your VPC.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement
	//
	EndpointManagement *string `field:"optional" json:"endpointManagement" yaml:"endpointManagement"`
	// The environment class type.
	//
	// Valid values: `mw1.small` , `mw1.medium` , `mw1.large` . To learn more, see [Amazon MWAA environment class](https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass
	//
	EnvironmentClass *string `field:"optional" json:"environmentClass" yaml:"environmentClass"`
	// The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
	//
	// For example, `arn:aws:iam::123456789:role/my-execution-role` . To learn more, see [Amazon MWAA Execution role](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn
	//
	ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
	// The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
	//
	// You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey
	//
	KmsKey *string `field:"optional" json:"kmsKey" yaml:"kmsKey"`
	// The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration
	//
	LoggingConfiguration interface{} `field:"optional" json:"loggingConfiguration" yaml:"loggingConfiguration"`
	// The maximum number of web servers that you want to run in your environment.
	//
	// Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in `MaxWebserers` . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
	//
	// Valid values: Accepts between `2` and `5` . Defaults to `2` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxwebservers
	//
	MaxWebservers *float64 `field:"optional" json:"maxWebservers" yaml:"maxWebservers"`
	// The maximum number of workers that you want to run in your environment.
	//
	// MWAA scales the number of Apache Airflow workers up to the number you specify in the `MaxWorkers` field. For example, `20` . When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in `MinWorkers` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers
	//
	MaxWorkers *float64 `field:"optional" json:"maxWorkers" yaml:"maxWorkers"`
	// The minimum number of web servers that you want to run in your environment.
	//
	// Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
	//
	// Valid values: Accepts between `2` and `5` . Defaults to `2` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minwebservers
	//
	MinWebservers *float64 `field:"optional" json:"minWebservers" yaml:"minWebservers"`
	// The minimum number of workers that you want to run in your environment.
	//
	// MWAA scales the number of Apache Airflow workers up to the number you specify in the `MaxWorkers` field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the `MinWorkers` field. For example, `2` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers
	//
	MinWorkers *float64 `field:"optional" json:"minWorkers" yaml:"minWorkers"`
	// The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
	//
	// To learn more, see [About networking on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration
	//
	NetworkConfiguration interface{} `field:"optional" json:"networkConfiguration" yaml:"networkConfiguration"`
	// The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion
	//
	PluginsS3ObjectVersion *string `field:"optional" json:"pluginsS3ObjectVersion" yaml:"pluginsS3ObjectVersion"`
	// The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path
	//
	PluginsS3Path *string `field:"optional" json:"pluginsS3Path" yaml:"pluginsS3Path"`
	// The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion
	//
	RequirementsS3ObjectVersion *string `field:"optional" json:"requirementsS3ObjectVersion" yaml:"requirementsS3ObjectVersion"`
	// The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path
	//
	RequirementsS3Path *string `field:"optional" json:"requirementsS3Path" yaml:"requirementsS3Path"`
	// The number of schedulers that you want to run in your environment. Valid values:.
	//
	// - *v2* - Accepts between 2 to 5. Defaults to 2.
	// - *v1* - Accepts 1.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers
	//
	Schedulers *float64 `field:"optional" json:"schedulers" yaml:"schedulers"`
	// The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
	//
	// For example, `arn:aws:s3:::my-airflow-bucket-unique-name` . To learn more, see [Create an Amazon S3 bucket for Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn
	//
	SourceBucketArn *string `field:"optional" json:"sourceBucketArn" yaml:"sourceBucketArn"`
	// The version of the startup shell script in your Amazon S3 bucket.
	//
	// You must specify the [version ID](https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) that Amazon S3 assigns to the file every time you update the script.
	//
	// Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
	//
	// `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
	//
	// For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion
	//
	StartupScriptS3ObjectVersion *string `field:"optional" json:"startupScriptS3ObjectVersion" yaml:"startupScriptS3ObjectVersion"`
	// The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
	//
	// Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path
	//
	StartupScriptS3Path *string `field:"optional" json:"startupScriptS3Path" yaml:"startupScriptS3Path"`
	// The key-value tag pairs associated to your environment. For example, `"Environment": "Staging"` . To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	//
	// If you specify new tags for an existing environment, the update requires service interruption before taking effect.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags
	//
	Tags interface{} `field:"optional" json:"tags" yaml:"tags"`
	// The Apache Airflow *Web server* access mode.
	//
	// To learn more, see [Apache Airflow access modes](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) . Valid values: `PRIVATE_ONLY` or `PUBLIC_ONLY` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode
	//
	WebserverAccessMode *string `field:"optional" json:"webserverAccessMode" yaml:"webserverAccessMode"`
	// The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .
	//
	// For example: `TUE:03:30` . You can specify a start time in 30 minute increments only. Supported input includes the following:
	//
	// - MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30).
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart
	//
	WeeklyMaintenanceWindowStart *string `field:"optional" json:"weeklyMaintenanceWindowStart" yaml:"weeklyMaintenanceWindowStart"`
}

Properties for defining a `CfnEnvironment`.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var airflowConfigurationOptions interface{}
var tags interface{}

cfnEnvironmentProps := &CfnEnvironmentProps{
	Name: jsii.String("name"),

	// the properties below are optional
	AirflowConfigurationOptions: airflowConfigurationOptions,
	AirflowVersion: jsii.String("airflowVersion"),
	DagS3Path: jsii.String("dagS3Path"),
	EndpointManagement: jsii.String("endpointManagement"),
	EnvironmentClass: jsii.String("environmentClass"),
	ExecutionRoleArn: jsii.String("executionRoleArn"),
	KmsKey: jsii.String("kmsKey"),
	LoggingConfiguration: &LoggingConfigurationProperty{
		DagProcessingLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		SchedulerLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		TaskLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		WebserverLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		WorkerLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
	},
	MaxWebservers: jsii.Number(123),
	MaxWorkers: jsii.Number(123),
	MinWebservers: jsii.Number(123),
	MinWorkers: jsii.Number(123),
	NetworkConfiguration: &NetworkConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
	PluginsS3ObjectVersion: jsii.String("pluginsS3ObjectVersion"),
	PluginsS3Path: jsii.String("pluginsS3Path"),
	RequirementsS3ObjectVersion: jsii.String("requirementsS3ObjectVersion"),
	RequirementsS3Path: jsii.String("requirementsS3Path"),
	Schedulers: jsii.Number(123),
	SourceBucketArn: jsii.String("sourceBucketArn"),
	StartupScriptS3ObjectVersion: jsii.String("startupScriptS3ObjectVersion"),
	StartupScriptS3Path: jsii.String("startupScriptS3Path"),
	Tags: tags,
	WebserverAccessMode: jsii.String("webserverAccessMode"),
	WeeklyMaintenanceWindowStart: jsii.String("weeklyMaintenanceWindowStart"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html

type CfnEnvironment_LoggingConfigurationProperty

type CfnEnvironment_LoggingConfigurationProperty struct {
	// Defines the processing logs sent to CloudWatch Logs and the logging level to send.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-loggingconfiguration.html#cfn-mwaa-environment-loggingconfiguration-dagprocessinglogs
	//
	DagProcessingLogs interface{} `field:"optional" json:"dagProcessingLogs" yaml:"dagProcessingLogs"`
	// Defines the scheduler logs sent to CloudWatch Logs and the logging level to send.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-loggingconfiguration.html#cfn-mwaa-environment-loggingconfiguration-schedulerlogs
	//
	SchedulerLogs interface{} `field:"optional" json:"schedulerLogs" yaml:"schedulerLogs"`
	// Defines the task logs sent to CloudWatch Logs and the logging level to send.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-loggingconfiguration.html#cfn-mwaa-environment-loggingconfiguration-tasklogs
	//
	TaskLogs interface{} `field:"optional" json:"taskLogs" yaml:"taskLogs"`
	// Defines the web server logs sent to CloudWatch Logs and the logging level to send.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-loggingconfiguration.html#cfn-mwaa-environment-loggingconfiguration-webserverlogs
	//
	WebserverLogs interface{} `field:"optional" json:"webserverLogs" yaml:"webserverLogs"`
	// Defines the worker logs sent to CloudWatch Logs and the logging level to send.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-loggingconfiguration.html#cfn-mwaa-environment-loggingconfiguration-workerlogs
	//
	WorkerLogs interface{} `field:"optional" json:"workerLogs" yaml:"workerLogs"`
}

The type of Apache Airflow logs to send to CloudWatch Logs.

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

loggingConfigurationProperty := &LoggingConfigurationProperty{
	DagProcessingLogs: &ModuleLoggingConfigurationProperty{
		CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
		Enabled: jsii.Boolean(false),
		LogLevel: jsii.String("logLevel"),
	},
	SchedulerLogs: &ModuleLoggingConfigurationProperty{
		CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
		Enabled: jsii.Boolean(false),
		LogLevel: jsii.String("logLevel"),
	},
	TaskLogs: &ModuleLoggingConfigurationProperty{
		CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
		Enabled: jsii.Boolean(false),
		LogLevel: jsii.String("logLevel"),
	},
	WebserverLogs: &ModuleLoggingConfigurationProperty{
		CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
		Enabled: jsii.Boolean(false),
		LogLevel: jsii.String("logLevel"),
	},
	WorkerLogs: &ModuleLoggingConfigurationProperty{
		CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
		Enabled: jsii.Boolean(false),
		LogLevel: jsii.String("logLevel"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-loggingconfiguration.html

type CfnEnvironment_ModuleLoggingConfigurationProperty

type CfnEnvironment_ModuleLoggingConfigurationProperty struct {
	// The ARN of the CloudWatch Logs log group for each type of Apache Airflow log type that you have enabled.
	//
	// > `CloudWatchLogGroupArn` is available only as a return value, accessible when specified as an attribute in the [`Fn:GetAtt`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#aws-resource-mwaa-environment-return-values) intrinsic function. Any value you provide for `CloudWatchLogGroupArn` is discarded by Amazon MWAA.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-moduleloggingconfiguration.html#cfn-mwaa-environment-moduleloggingconfiguration-cloudwatchloggrouparn
	//
	CloudWatchLogGroupArn *string `field:"optional" json:"cloudWatchLogGroupArn" yaml:"cloudWatchLogGroupArn"`
	// Indicates whether to enable the Apache Airflow log type (e.g. `DagProcessingLogs` ) in CloudWatch Logs.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-moduleloggingconfiguration.html#cfn-mwaa-environment-moduleloggingconfiguration-enabled
	//
	Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
	// Defines the Apache Airflow logs to send for the log type (e.g. `DagProcessingLogs` ) to CloudWatch Logs. Valid values: `CRITICAL` , `ERROR` , `WARNING` , `INFO` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-moduleloggingconfiguration.html#cfn-mwaa-environment-moduleloggingconfiguration-loglevel
	//
	LogLevel *string `field:"optional" json:"logLevel" yaml:"logLevel"`
}

Defines the type of logs to send for the Apache Airflow log type (e.g. `DagProcessingLogs` ).

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

moduleLoggingConfigurationProperty := &ModuleLoggingConfigurationProperty{
	CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
	Enabled: jsii.Boolean(false),
	LogLevel: jsii.String("logLevel"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-moduleloggingconfiguration.html

type CfnEnvironment_NetworkConfigurationProperty

type CfnEnvironment_NetworkConfigurationProperty struct {
	// A list of one or more security group IDs.
	//
	// Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see [Security in your VPC on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-networkconfiguration.html#cfn-mwaa-environment-networkconfiguration-securitygroupids
	//
	SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
	// A list of subnet IDs.
	//
	// *Required* to create an environment. Must be private subnets in two different availability zones. A subnet must be attached to the same VPC as the security group. To learn more, see [About networking on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-networkconfiguration.html#cfn-mwaa-environment-networkconfiguration-subnetids
	//
	SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
}

The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.

To learn more, see [About networking on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .

Example:

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

networkConfigurationProperty := &NetworkConfigurationProperty{
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	SubnetIds: []*string{
		jsii.String("subnetIds"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mwaa-environment-networkconfiguration.html

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL