CreateEnvironmentRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEnvironmentRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`airflowConfigurationOptions()` The Apache Airflow configuration setting you want to override in your environment.
`String`	`airflowVersion()` The Apache Airflow version you want to use for your environment.
`static CreateEnvironmentRequest.Builder`	`builder()`
`String`	`dagS3Path()` The relative path to the DAG folder on your Amazon S3 storage bucket.
`String`	`environmentClass()` The environment class you want to use for your environment.
`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()` Returns true if the AirflowConfigurationOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKey()` The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
`LoggingConfigurationInput`	`loggingConfiguration()` The Apache Airflow logs you want to send to Amazon CloudWatch Logs.
`Integer`	`maxWorkers()` The maximum number of workers that you want to run in your environment.
`String`	`name()` The name of your MWAA environment.
`NetworkConfiguration`	`networkConfiguration()` The VPC networking components you want to use for your environment.
`String`	`pluginsS3ObjectVersion()` The `plugins.zip` file version you want to use.
`String`	`pluginsS3Path()` The relative path to the `plugins.zip` file on your Amazon S3 storage bucket.
`String`	`requirementsS3ObjectVersion()` The `requirements.txt` file version you want to use.
`String`	`requirementsS3Path()` The relative path to the `requirements.txt` file on your Amazon S3 storage bucket.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateEnvironmentRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceBucketArn()` The Amazon Resource Name (ARN) of your Amazon S3 storage bucket.
`Map<String,String>`	`tags()` The metadata tags you want to attach to your environment.
`CreateEnvironmentRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`WebserverAccessMode`	`webserverAccessMode()` The networking access of your Apache Airflow web server.
`String`	`webserverAccessModeAsString()` The networking access of your Apache Airflow web server.
`String`	`weeklyMaintenanceWindowStart()` The day and time you want MWAA to start weekly maintenance updates on your environment.

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()
```
    Returns true if the AirflowConfigurationOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - airflowConfigurationOptions
```
public final Map<String,String> airflowConfigurationOptions()
```
    The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAirflowConfigurationOptions() to see if a value was sent in this field.
    
    Returns:
    
    The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration.
  - airflowVersion
```
public final String airflowVersion()
```
    The Apache Airflow version you want to use for your environment.
    
    Returns:
    
    The Apache Airflow version you want to use for your environment.
  - dagS3Path
```
public final String dagS3Path()
```
    The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.
    
    Returns:
    
    The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.
  - environmentClass
```
public final String environmentClass()
```
    The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services.
    
    Returns:
    
    The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services.
  - executionRoleArn
```
public final String executionRoleArn()
```
    The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow.
  - kmsKey
```
public final String kmsKey()
```
    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 custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide.
    
    Returns:
    
    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 custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide.
  - loggingConfiguration
```
public final LoggingConfigurationInput loggingConfiguration()
```
    The Apache Airflow logs you want to send to Amazon CloudWatch Logs.
    
    Returns:
    
    The Apache Airflow logs you want to send to Amazon 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 and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.
    
    Returns:
    
    The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.
  - name
```
public final String name()
```
    The name of your MWAA environment.
    
    Returns:
    
    The name of your MWAA environment.
  - networkConfiguration
```
public final NetworkConfiguration networkConfiguration()
```
    The VPC networking components you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.
    
    Returns:
    
    The VPC networking components you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.
  - pluginsS3ObjectVersion
```
public final String pluginsS3ObjectVersion()
```
    The plugins.zip file version you want to use.
    
    Returns:
    
    The plugins.zip file version you want to use.
  - pluginsS3Path
```
public final String pluginsS3Path()
```
    The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then PluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.
    
    Returns:
    
    The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then PluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.
  - requirementsS3ObjectVersion
```
public final String requirementsS3ObjectVersion()
```
    The requirements.txt file version you want to use.
    
    Returns:
    
    The requirements.txt file version you want to use.
  - requirementsS3Path
```
public final String requirementsS3Path()
```
    The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then RequirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.
    
    Returns:
    
    The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then RequirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.
  - sourceBucketArn
```
public final String sourceBucketArn()
```
    The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.
    
    Returns:
    
    The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources.
  - webserverAccessMode
```
public final WebserverAccessMode webserverAccessMode()
```
    The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.
    
    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 networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.
    
    See Also:
    
    WebserverAccessMode
  - webserverAccessModeAsString
```
public final String webserverAccessModeAsString()
```
    The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.
    
    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 networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.
    
    See Also:
    
    WebserverAccessMode
  - weeklyMaintenanceWindowStart
```
public final String weeklyMaintenanceWindowStart()
```
    The day and time you want MWAA to start weekly maintenance updates on your environment.
    
    Returns:
    
    The day and time you want MWAA to start weekly maintenance updates on your environment.
  - 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

Class CreateEnvironmentRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hasAirflowConfigurationOptions

airflowConfigurationOptions

airflowVersion

dagS3Path

environmentClass

executionRoleArn

kmsKey

loggingConfiguration

maxWorkers

name

networkConfiguration

pluginsS3ObjectVersion

pluginsS3Path

requirementsS3ObjectVersion

requirementsS3Path

sourceBucketArn

hasTags

tags

webserverAccessMode

webserverAccessModeAsString

weeklyMaintenanceWindowStart

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields