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 AWS CodeDeploy CreateDeploymentConfig API operation.

Syntax

New-CDDeploymentConfig
-DeploymentConfigName <String>
-TimeBasedCanary_CanaryInterval <Int32>
-TimeBasedCanary_CanaryPercentage <Int32>
-ComputePlatform <ComputePlatform>
-ZonalConfig_FirstZoneMonitorDurationInSecond <Int64>
-TimeBasedLinear_LinearInterval <Int32>
-TimeBasedLinear_LinearPercentage <Int32>
-ZonalConfig_MonitorDurationInSecond <Int64>
-MinimumHealthyHosts_Type <MinimumHealthyHostsType>
-TrafficRoutingConfig_Type <TrafficRoutingType>
-MinimumHealthyHostsPerZone_Type <MinimumHealthyHostsPerZoneType>
-MinimumHealthyHosts_Value <Int32>
-MinimumHealthyHostsPerZone_Value <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCodeDeployConfig>

Description

Creates a deployment configuration.

Parameters

-ClientConfig <AmazonCodeDeployConfig>
Amazon.PowerShell.Cmdlets.CD.AmazonCodeDeployClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputePlatform <ComputePlatform>
The destination platform type for the deployment (Lambda, Server, or ECS).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentConfigName <String>
The name of the deployment configuration to create.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
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)
-MinimumHealthyHosts_Type <MinimumHealthyHostsType>
The minimum healthy instance type:
  • HOST_COUNT: The minimum number of healthy instances as an absolute value.
  • FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.For more information, see CodeDeploy Instance Health in the CodeDeploy User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MinimumHealthyHosts_Value <Int32>
The minimum healthy instance value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MinimumHealthyHostsPerZone_Type <MinimumHealthyHostsPerZoneType>
The type associated with the MinimumHealthyHostsPerZone option.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesZonalConfig_MinimumHealthyHostsPerZone_Type
-MinimumHealthyHostsPerZone_Value <Int32>
The value associated with the MinimumHealthyHostsPerZone option.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesZonalConfig_MinimumHealthyHostsPerZone_Value
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DeploymentConfigName parameter. The -PassThru parameter is deprecated, use -Select '^DeploymentConfigName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DeploymentConfigId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeDeploy.Model.CreateDeploymentConfigResponse). Specifying the name of a property of type Amazon.CodeDeploy.Model.CreateDeploymentConfigResponse 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)
-TimeBasedCanary_CanaryInterval <Int32>
The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrafficRoutingConfig_TimeBasedCanary_CanaryInterval
-TimeBasedCanary_CanaryPercentage <Int32>
The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrafficRoutingConfig_TimeBasedCanary_CanaryPercentage
-TimeBasedLinear_LinearInterval <Int32>
The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrafficRoutingConfig_TimeBasedLinear_LinearInterval
-TimeBasedLinear_LinearPercentage <Int32>
The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrafficRoutingConfig_TimeBasedLinear_LinearPercentage
-TrafficRoutingConfig_Type <TrafficRoutingType>
The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ZonalConfig_FirstZoneMonitorDurationInSecond <Int64>
The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for firstZoneMonitorDurationInSeconds, then CodeDeploy uses the monitorDurationInSeconds value for the first Availability Zone.For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesZonalConfig_FirstZoneMonitorDurationInSeconds
-ZonalConfig_MonitorDurationInSecond <Int64>
The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a monitorDurationInSeconds, CodeDeploy starts deploying to the next Availability Zone immediately.For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesZonalConfig_MonitorDurationInSeconds

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

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

Examples

Example 1

New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2

0f3e8187-44ef-42da-aeed-b6823EXAMPLE
This example creates a new deployment configuration with the specified name and behavior.

Supported Version

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