Class CreateEnvironmentRequest
- All Implemented Interfaces:
SdkPojo
,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
-
Method Summary
Modifier and TypeMethodDescriptionA list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment.final String
The Apache Airflow version for your environment.builder()
final String
The relative path to the DAGs folder on your Amazon S3 bucket.final EndpointManagement
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.final String
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.final String
The environment class type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the execution role for your environment.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKey()
The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment.Defines the Apache Airflow logs to send to CloudWatch Logs.final Integer
The maximum number of workers that you want to run in your environment.final Integer
The minimum number of workers that you want to run in your environment.final String
name()
The name of the Amazon MWAA environment.final NetworkConfiguration
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.final String
The version of the plugins.zip file on your Amazon S3 bucket.final String
The relative path to theplugins.zip
file on your Amazon S3 bucket.final String
The version of therequirements.txt
file on your Amazon S3 bucket.final String
The relative path to therequirements.txt
file on your Amazon S3 bucket.final Integer
The number of Apache Airflow schedulers to run in your environment.static Class
<? extends CreateEnvironmentRequest.Builder> final String
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.final String
The version of the startup shell script in your Amazon S3 bucket.final String
The relative path to the startup shell script in your Amazon S3 bucket.tags()
The key-value tag pairs you want to associate to your environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final WebserverAccessMode
Defines the access mode for the Apache Airflow web server.final String
Defines the access mode for the Apache Airflow web server.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, 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. For more information, see Apache Airflow configuration options.
-
airflowVersion
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
Valid 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
- Returns:
- The Apache Airflow version for your environment. If no value is specified, it defaults to the latest
version. For more information, see Apache Airflow versions on
Amazon Managed Workflows for Apache Airflow (MWAA).
Valid 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
-
dagS3Path
The relative path to the DAGs folder on your Amazon S3 bucket. For example,
dags
. For more information, see Adding or updating DAGs.- Returns:
- The relative path to the DAGs folder on your Amazon S3 bucket. For example,
dags
. For more information, see Adding or updating DAGs.
-
endpointManagement
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 toCUSTOMER
, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value toCUSTOMER
. In a shared VPC deployment, the environment will remain inPENDING
status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change toCREATE_FAILED
. You can delete the failed environment and create a new one.If the service returns an enum value that is not available in the current SDK version,
endpointManagement
will returnEndpointManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointManagementAsString()
.- Returns:
- 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 toCUSTOMER
, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value toCUSTOMER
. In a shared VPC deployment, the environment will remain inPENDING
status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change toCREATE_FAILED
. You can delete the failed environment and create a new one. - See Also:
-
endpointManagementAsString
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 toCUSTOMER
, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value toCUSTOMER
. In a shared VPC deployment, the environment will remain inPENDING
status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change toCREATE_FAILED
. You can delete the failed environment and create a new one.If the service returns an enum value that is not available in the current SDK version,
endpointManagement
will returnEndpointManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointManagementAsString()
.- Returns:
- 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 toCUSTOMER
, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value toCUSTOMER
. In a shared VPC deployment, the environment will remain inPENDING
status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change toCREATE_FAILED
. You can delete the failed environment and create a new one. - See Also:
-
environmentClass
The environment class type. Valid values:
mw1.small
,mw1.medium
,mw1.large
. For more information, see Amazon MWAA environment class.- Returns:
- The environment class type. Valid values:
mw1.small
,mw1.medium
,mw1.large
. For more information, see Amazon MWAA environment class.
-
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
. For more information, 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
. For more information, see Amazon MWAA Execution role.
-
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). For more information, 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). For more information, see Create an Amazon MWAA environment.
-
loggingConfiguration
Defines the Apache Airflow logs to send to CloudWatch Logs.
- Returns:
- Defines the Apache Airflow logs to send to CloudWatch Logs.
-
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 inMinWorkers
.- 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 inMinWorkers
.
-
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 theMinWorkers
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 theMinWorkers
field. For example,2
.
-
name
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.- Returns:
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
-
networkConfiguration
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, 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. For more information, see About networking on Amazon MWAA.
-
pluginsS3ObjectVersion
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.
- Returns:
- The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.
-
pluginsS3Path
The relative path to the
plugins.zip
file on your Amazon S3 bucket. For example,plugins.zip
. If specified, then theplugins.zip
version is required. For more information, 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 theplugins.zip
version is required. For more information, see Installing custom plugins.
-
requirementsS3ObjectVersion
The version of the
requirements.txt
file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.- Returns:
- The version of the
requirements.txt
file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.
-
requirementsS3Path
The relative path to the
requirements.txt
file on your Amazon S3 bucket. For example,requirements.txt
. If specified, then a version is required. For more information, 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 version is required. For more information, see Installing Python dependencies.
-
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
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
. For more information, 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
. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
-
startupScriptS3ObjectVersion
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID 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.
- Returns:
- The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID
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.
-
startupScriptS3Path
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.
- Returns:
- 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.
-
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 theisEmpty()
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
The key-value tag pairs you want to associate to your environment. For example,
"Environment": "Staging"
. For more information, 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"
. For more information, see Tagging Amazon Web Services resources.
-
webserverAccessMode
Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
If the service returns an enum value that is not available in the current SDK version,
webserverAccessMode
will returnWebserverAccessMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwebserverAccessModeAsString()
.- Returns:
- Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
- See Also:
-
webserverAccessModeAsString
Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
If the service returns an enum value that is not available in the current SDK version,
webserverAccessMode
will returnWebserverAccessMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwebserverAccessModeAsString()
.- Returns:
- Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
- See Also:
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateEnvironmentRequest.Builder,
CreateEnvironmentRequest> - Specified by:
toBuilder
in classMwaaRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-