software.amazon.awssdk.services.mwaa.model

Class CreateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mwaa.model.MwaaRequest

software.amazon.awssdk.services.mwaa.model.CreateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEnvironmentRequest
extends MwaaRequest
implements ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	airflowConfigurationOptions() A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment.
String	airflowVersion() The Apache Airflow version for your environment.
static CreateEnvironmentRequest.Builder	builder()
String	dagS3Path() The relative path to the DAGs folder on your Amazon S3 bucket.
String	environmentClass() The environment class type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The Amazon Resource Name (ARN) of the execution role for your environment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAirflowConfigurationOptions() For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	kmsKey() The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment.
LoggingConfigurationInput	loggingConfiguration() Defines the Apache Airflow logs to send to CloudWatch Logs.
Integer	maxWorkers() The maximum number of workers that you want to run in your environment.
Integer	minWorkers() The minimum number of workers that you want to run in your environment.
String	name() The name of the Amazon MWAA environment.
NetworkConfiguration	networkConfiguration() The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.
String	pluginsS3ObjectVersion() The version of the plugins.zip file on your Amazon S3 bucket.
String	pluginsS3Path() The relative path to the plugins.zip file on your Amazon S3 bucket.
String	requirementsS3ObjectVersion() The version of the requirements.txt file on your Amazon S3 bucket.
String	requirementsS3Path() The relative path to the requirements.txt file on your Amazon S3 bucket.
Integer	schedulers() The number of Apache Airflow schedulers to run in your environment.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEnvironmentRequest.Builder>	serializableBuilderClass()
String	sourceBucketArn() The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
Map<String,String>	tags() The key-value tag pairs you want to associate to your environment.
CreateEnvironmentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WebserverAccessMode	webserverAccessMode() The Apache Airflow Web server access mode.
String	webserverAccessModeAsString() The Apache Airflow Web server access mode.
String	weeklyMaintenanceWindowStart() The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasAirflowConfigurationOptions

public final boolean hasAirflowConfigurationOptions()

For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

airflowConfigurationOptions

public final Map<String,String> airflowConfigurationOptions()

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAirflowConfigurationOptions() method.

Returns:

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

airflowVersion

public final String airflowVersion()

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, and 2.2.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

Returns:

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, and 2.2.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

dagS3Path

public final String dagS3Path()

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

Returns:

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

environmentClass

public final String environmentClass()

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large . To learn more, see Amazon MWAA environment class.

Returns:

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

executionRoleArn

public final String executionRoleArn()

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

Returns:

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

kmsKey

public final String kmsKey()

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.

Returns:

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.

loggingConfiguration

public final LoggingConfigurationInput loggingConfiguration()

Defines the Apache Airflow logs to send to CloudWatch Logs.

Returns:

Defines the Apache Airflow logs to send to CloudWatch Logs.

maxWorkers

public final Integer maxWorkers()

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.

Returns:

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.

minWorkers

public final Integer minWorkers()

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.

Returns:

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.

name

public final String name()

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Returns:

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

networkConfiguration

public final NetworkConfiguration networkConfiguration()

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

Returns:

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

pluginsS3ObjectVersion

public final String pluginsS3ObjectVersion()

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

Returns:

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

pluginsS3Path

public final String pluginsS3Path()

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

Returns:

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

requirementsS3ObjectVersion

public final String requirementsS3ObjectVersion()

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

Returns:

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

requirementsS3Path

public final String requirementsS3Path()

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

Returns:

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

schedulers

public final Integer schedulers()

The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - Accepts between 2 to 5. Defaults to 2.

• v1 - Accepts 1.

Returns:

The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - Accepts between 2 to 5. Defaults to 2.

• v1 - Accepts 1.

sourceBucketArn

public final String sourceBucketArn()

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.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging Amazon Web Services resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging Amazon Web Services resources.

webserverAccessMode

public final WebserverAccessMode webserverAccessMode()

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

If the service returns an enum value that is not available in the current SDK version, webserverAccessMode will return WebserverAccessMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from webserverAccessModeAsString().

Returns:

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

See Also:

WebserverAccessMode

webserverAccessModeAsString

public final String webserverAccessModeAsString()

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

If the service returns an enum value that is not available in the current SDK version, webserverAccessMode will return WebserverAccessMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from webserverAccessModeAsString().

Returns:

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

See Also:

WebserverAccessMode

weeklyMaintenanceWindowStart

public final String weeklyMaintenanceWindowStart()

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.

Returns:

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.

toBuilder

public CreateEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Specified by:

toBuilder in class MwaaRequest

builder

public static CreateEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo