AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AmazonMWAAServerless CreateWorkflow API operation.

Syntax

New-MWAASWorkflow
-DefinitionS3Location_Bucket <String>
-Description <String>
-EngineVersion <Int32>
-EncryptionConfiguration_KmsKeyId <String>
-LoggingConfiguration_LogGroupName <String>
-Name <String>
-DefinitionS3Location_ObjectKey <String>
-RoleArn <String>
-NetworkConfiguration_SecurityGroupId <String[]>
-NetworkConfiguration_SubnetId <String[]>
-Tag <Hashtable>
-TriggerMode <String>
-EncryptionConfiguration_Type <EncryptionType>
-DefinitionS3Location_VersionId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMWAAServerlessConfig>

Description

Creates a new workflow in Amazon Managed Workflows for Apache Airflow Serverless. This operation initializes a workflow with the specified configuration including the workflow definition, execution role, and optional settings for encryption, logging, and networking. You must provide the workflow definition as a YAML file stored in Amazon S3 that defines the DAG structure using supported Amazon Web Services operators. Amazon Managed Workflows for Apache Airflow Serverless automatically creates the first version of the workflow and sets up the necessary execution environment with multi-tenant isolation and security controls.

Parameters

-ClientConfig <AmazonMWAAServerlessConfig>
Amazon.PowerShell.Cmdlets.MWAAS.AmazonMWAAServerlessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow creation requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionS3Location_Bucket <String>
The name of the Amazon S3 bucket that contains the workflow definition file.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionS3Location_ObjectKey <String>
The key (name) of the workflow definition file within the S3 bucket.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionS3Location_VersionId <String>
Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
An optional description of the workflow that you can use to provide additional context about the workflow's purpose and functionality.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_KmsKeyId <String>
The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when Type is CUSTOMER_MANAGED_KEY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionConfiguration_Type <EncryptionType>
The type of encryption to use. Values are AWS_MANAGED_KEY (Amazon Web Services manages the encryption key) or CUSTOMER_MANAGED_KEY (you provide a KMS key).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <Int32>
The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for this workflow. This determines the feature set, supported operators, and execution environment capabilities available to your workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains backward compatibility across versions while introducing new features and improvements. Currently supports version 1 with plans for additional versions as the service evolves.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoggingConfiguration_LogGroupName <String>
The name of the CloudWatch log group where workflow execution logs are stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the workflow. You must use unique workflow names within your Amazon Web Services account. The service generates a unique identifier that is appended to ensure temporal uniqueness across the account lifecycle.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_SecurityGroupId <String[]>
A list of VPC security group IDs to associate with the workflow execution environment. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SecurityGroupIds
-NetworkConfiguration_SubnetId <String[]>
A list of VPC subnet IDs where the workflow execution environment is deployed. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SubnetIds
-RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAAServerless.Model.CreateWorkflowResponse). Specifying the name of a property of type Amazon.MWAAServerless.Model.CreateWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TriggerMode <String>
The trigger mode for the workflow execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.MWAAServerless.Model.CreateWorkflowResponse
This cmdlet returns an Amazon.MWAAServerless.Model.CreateWorkflowResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z