AWS Elastic Beanstalk: New-EBApplication Cmdlet

Synopsis

Calls the AWS Elastic Beanstalk CreateApplication API operation.

Syntax

New-EBApplication
-ApplicationName <String>
-Description <String>
-MaxAgeRule_DeleteSourceFromS3 <Boolean>
-MaxCountRule_DeleteSourceFromS3 <Boolean>
-MaxAgeRule_Enabled <Boolean>
-MaxCountRule_Enabled <Boolean>
-MaxAgeRule_MaxAgeInDay <Int32>
-MaxCountRule_MaxCount <Int32>
-ResourceLifecycleConfig_ServiceRole <String>
-Tag <Tag[]>
-Force <SwitchParameter>

Description

Creates an application that has one configuration template named default and no application versions.

Parameters

-ApplicationName <String>

The name of the application.Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.

Required?	False
Position?	1
Accept pipeline input?	True (ByValue, ByPropertyName)

-Description <String>

Describes the application.

Required?	False
Position?	2
Accept pipeline input?	False

-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?	False

-MaxAgeRule_DeleteSourceFromS3 <Boolean>

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ResourceLifecycleConfig_VersionLifecycleConfig_MaxAgeRule_DeleteSourceFromS3

-MaxAgeRule_Enabled <Boolean>

Specify true to apply the rule, or false to disable it.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ResourceLifecycleConfig_VersionLifecycleConfig_MaxAgeRule_Enabled

-MaxAgeRule_MaxAgeInDay <Int32>

Specify the number of days to retain an application versions.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ResourceLifecycleConfig_VersionLifecycleConfig_MaxAgeRule_MaxAgeInDays

-MaxCountRule_DeleteSourceFromS3 <Boolean>

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ResourceLifecycleConfig_VersionLifecycleConfig_MaxCountRule_DeleteSourceFromS3

-MaxCountRule_Enabled <Boolean>

Specify true to apply the rule, or false to disable it.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ResourceLifecycleConfig_VersionLifecycleConfig_MaxCountRule_Enabled

-MaxCountRule_MaxCount <Int32>

Specify the maximum number of application versions to retain.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ResourceLifecycleConfig_VersionLifecycleConfig_MaxCountRule_MaxCount

-ResourceLifecycleConfig_ServiceRole <String>

The ARN of an IAM service role that Elastic Beanstalk has permission to assume.The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

Required?	False
Position?	Named
Accept pipeline input?	False

-Tag <Tag[]>

Specifies the tags applied to the application.Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	Tags

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?	False

-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?	False

-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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?	False

-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?	False

-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?	False

-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?	False

-SessionToken <String>

The session token if the access and secret keys are temporary session-based credentials.

Required?	False
Position?	Named
Accept pipeline input?	False

-Region <String>

The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.

Required?	False
Position?	Named
Accept pipeline input?	False

-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?	False

Inputs

System.String

You can pipe a String object to this cmdlet for the ApplicationName parameter.

Outputs

Amazon.ElasticBeanstalk.Model.ApplicationDescription

This cmdlet returns a ApplicationDescription object. The service call response (type Amazon.ElasticBeanstalk.Model.CreateApplicationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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

Link to this page Did this page help you? Yes No Tell us about it...

New-EBApplication Cmdlet