All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDeploymentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  CreateDeploymentRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreateDeploymentRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getApplicationName () The name of an CodeDeploy application associated with the user or Amazon Web Services account.
  AutoRollbackConfiguration	getAutoRollbackConfiguration () Configuration information for an automatic rollback that is added when a deployment is created.
  String	getDeploymentConfigName () The name of a deployment configuration associated with the user or Amazon Web Services account.
  String	getDeploymentGroupName () The name of the deployment group.
  String	getDescription () A comment about the deployment.
  String	getFileExistsBehavior () Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
  Boolean	getIgnoreApplicationStopFailures () If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.
  AlarmConfiguration	getOverrideAlarmConfiguration () Allows you to specify information about alarms associated with a deployment.
  RevisionLocation	getRevision () The type and location of the revision to deploy.
  TargetInstances	getTargetInstances () Information about the instances that belong to the replacement environment in a blue/green deployment.
  Boolean	getUpdateOutdatedInstancesOnly () Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
  int	hashCode ()
  Boolean	isIgnoreApplicationStopFailures () If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.
  Boolean	isUpdateOutdatedInstancesOnly () Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
  void	setApplicationName (String applicationName) The name of an CodeDeploy application associated with the user or Amazon Web Services account.
  void	setAutoRollbackConfiguration (AutoRollbackConfiguration autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment is created.
  void	setDeploymentConfigName (String deploymentConfigName) The name of a deployment configuration associated with the user or Amazon Web Services account.
  void	setDeploymentGroupName (String deploymentGroupName) The name of the deployment group.
  void	setDescription (String description) A comment about the deployment.
  void	setFileExistsBehavior (FileExistsBehavior fileExistsBehavior) Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
  void	setFileExistsBehavior (String fileExistsBehavior) Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
  void	setIgnoreApplicationStopFailures (Boolean ignoreApplicationStopFailures) If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.
  void	setOverrideAlarmConfiguration (AlarmConfiguration overrideAlarmConfiguration) Allows you to specify information about alarms associated with a deployment.
  void	setRevision (RevisionLocation revision) The type and location of the revision to deploy.
  void	setTargetInstances (TargetInstances targetInstances) Information about the instances that belong to the replacement environment in a blue/green deployment.
  void	setUpdateOutdatedInstancesOnly (Boolean updateOutdatedInstancesOnly) Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.
  String	toString () Returns a string representation of this object.
  CreateDeploymentRequest	withApplicationName (String applicationName) The name of an CodeDeploy application associated with the user or Amazon Web Services account.
  CreateDeploymentRequest	withAutoRollbackConfiguration (AutoRollbackConfiguration autoRollbackConfiguration) Configuration information for an automatic rollback that is added when a deployment is created.
  CreateDeploymentRequest	withDeploymentConfigName (String deploymentConfigName) The name of a deployment configuration associated with the user or Amazon Web Services account.
  CreateDeploymentRequest	withDeploymentGroupName (String deploymentGroupName) The name of the deployment group.
  CreateDeploymentRequest	withDescription (String description) A comment about the deployment.
  CreateDeploymentRequest	withFileExistsBehavior (FileExistsBehavior fileExistsBehavior) Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
  CreateDeploymentRequest	withFileExistsBehavior (String fileExistsBehavior) Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
  CreateDeploymentRequest	withIgnoreApplicationStopFailures (Boolean ignoreApplicationStopFailures) If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event.
  CreateDeploymentRequest	withOverrideAlarmConfiguration (AlarmConfiguration overrideAlarmConfiguration) Allows you to specify information about alarms associated with a deployment.
  CreateDeploymentRequest	withRevision (RevisionLocation revision) The type and location of the revision to deploy.
  CreateDeploymentRequest	withTargetInstances (TargetInstances targetInstances) Information about the instances that belong to the replacement environment in a blue/green deployment.
  CreateDeploymentRequest	withUpdateOutdatedInstancesOnly (Boolean updateOutdatedInstancesOnly) Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • CreateDeploymentRequest

    public CreateDeploymentRequest()

• Method Detail

  • setApplicationName

    public void setApplicationName(String applicationName)

    The name of an CodeDeploy application associated with the user or Amazon Web Services account.

    Parameters:

    applicationName - The name of an CodeDeploy application associated with the user or Amazon Web Services account.

  • getApplicationName

    public String getApplicationName()

    The name of an CodeDeploy application associated with the user or Amazon Web Services account.

    Returns:

    The name of an CodeDeploy application associated with the user or Amazon Web Services account.

  • withApplicationName

    public CreateDeploymentRequest withApplicationName(String applicationName)

    The name of an CodeDeploy application associated with the user or Amazon Web Services account.

    Parameters:

    applicationName - The name of an CodeDeploy application associated with the user or Amazon Web Services account.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDeploymentGroupName

    public void setDeploymentGroupName(String deploymentGroupName)

    The name of the deployment group.

    Parameters:

    deploymentGroupName - The name of the deployment group.

  • getDeploymentGroupName

    public String getDeploymentGroupName()

    The name of the deployment group.

    Returns:

    The name of the deployment group.

  • withDeploymentGroupName

    public CreateDeploymentRequest withDeploymentGroupName(String deploymentGroupName)

    The name of the deployment group.

    Parameters:

    deploymentGroupName - The name of the deployment group.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setRevision

    public void setRevision(RevisionLocation revision)

    The type and location of the revision to deploy.

    Parameters:

    revision - The type and location of the revision to deploy.

  • getRevision

    public RevisionLocation getRevision()

    The type and location of the revision to deploy.

    Returns:

    The type and location of the revision to deploy.

  • withRevision

    public CreateDeploymentRequest withRevision(RevisionLocation revision)

    The type and location of the revision to deploy.

    Parameters:

    revision - The type and location of the revision to deploy.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDeploymentConfigName

    public void setDeploymentConfigName(String deploymentConfigName)

    The name of a deployment configuration associated with the user or Amazon Web Services account.

    If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault. OneAtATime is used by default.

    Parameters:

    deploymentConfigName - The name of a deployment configuration associated with the user or Amazon Web Services account.

    If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault. OneAtATime is used by default.

  • getDeploymentConfigName

    public String getDeploymentConfigName()

    The name of a deployment configuration associated with the user or Amazon Web Services account.

    If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault. OneAtATime is used by default.

    Returns:

    The name of a deployment configuration associated with the user or Amazon Web Services account.

    If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault. OneAtATime is used by default.

  • withDeploymentConfigName

    public CreateDeploymentRequest withDeploymentConfigName(String deploymentConfigName)

    The name of a deployment configuration associated with the user or Amazon Web Services account.

    If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault. OneAtATime is used by default.

    Parameters:

    deploymentConfigName - The name of a deployment configuration associated with the user or Amazon Web Services account.

    If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault. OneAtATime is used by default.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDescription

    public void setDescription(String description)

    A comment about the deployment.

    Parameters:

    description - A comment about the deployment.

  • getDescription

    public String getDescription()

    A comment about the deployment.

    Returns:

    A comment about the deployment.

  • withDescription

    public CreateDeploymentRequest withDescription(String description)

    A comment about the deployment.

    Parameters:

    description - A comment about the deployment.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setIgnoreApplicationStopFailures

    public void setIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)

    If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

    Parameters:

    ignoreApplicationStopFailures - If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

  • getIgnoreApplicationStopFailures

    public Boolean getIgnoreApplicationStopFailures()

    If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

    Returns:

    If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

  • withIgnoreApplicationStopFailures

    public CreateDeploymentRequest withIgnoreApplicationStopFailures(Boolean ignoreApplicationStopFailures)

    If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

    Parameters:

    ignoreApplicationStopFailures - If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isIgnoreApplicationStopFailures

    public Boolean isIgnoreApplicationStopFailures()

    If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

    Returns:

    If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

    If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

    During a deployment, the CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

    If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

  • setTargetInstances

    public void setTargetInstances(TargetInstances targetInstances)

    Information about the instances that belong to the replacement environment in a blue/green deployment.

    Parameters:

    targetInstances - Information about the instances that belong to the replacement environment in a blue/green deployment.

  • getTargetInstances

    public TargetInstances getTargetInstances()

    Information about the instances that belong to the replacement environment in a blue/green deployment.

    Returns:

    Information about the instances that belong to the replacement environment in a blue/green deployment.

  • withTargetInstances

    public CreateDeploymentRequest withTargetInstances(TargetInstances targetInstances)

    Information about the instances that belong to the replacement environment in a blue/green deployment.

    Parameters:

    targetInstances - Information about the instances that belong to the replacement environment in a blue/green deployment.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setAutoRollbackConfiguration

    public void setAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

    Configuration information for an automatic rollback that is added when a deployment is created.

    Parameters:

    autoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment is created.

  • getAutoRollbackConfiguration

    public AutoRollbackConfiguration getAutoRollbackConfiguration()

    Configuration information for an automatic rollback that is added when a deployment is created.

    Returns:

    Configuration information for an automatic rollback that is added when a deployment is created.

  • withAutoRollbackConfiguration

    public CreateDeploymentRequest withAutoRollbackConfiguration(AutoRollbackConfiguration autoRollbackConfiguration)

    Configuration information for an automatic rollback that is added when a deployment is created.

    Parameters:

    autoRollbackConfiguration - Configuration information for an automatic rollback that is added when a deployment is created.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setUpdateOutdatedInstancesOnly

    public void setUpdateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)

    Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

    Parameters:

    updateOutdatedInstancesOnly - Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

  • getUpdateOutdatedInstancesOnly

    public Boolean getUpdateOutdatedInstancesOnly()

    Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

    Returns:

    Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

  • withUpdateOutdatedInstancesOnly

    public CreateDeploymentRequest withUpdateOutdatedInstancesOnly(Boolean updateOutdatedInstancesOnly)

    Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

    Parameters:

    updateOutdatedInstancesOnly - Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • isUpdateOutdatedInstancesOnly

    public Boolean isUpdateOutdatedInstancesOnly()

    Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

    Returns:

    Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

  • setFileExistsBehavior

    public void setFileExistsBehavior(String fileExistsBehavior)

    Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Parameters:

    fileExistsBehavior - Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    See Also:

    FileExistsBehavior

  • getFileExistsBehavior

    public String getFileExistsBehavior()

    Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Returns:

    Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    See Also:

    FileExistsBehavior

  • withFileExistsBehavior

    public CreateDeploymentRequest withFileExistsBehavior(String fileExistsBehavior)

    Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Parameters:

    fileExistsBehavior - Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    FileExistsBehavior

  • setFileExistsBehavior

    public void setFileExistsBehavior(FileExistsBehavior fileExistsBehavior)

    Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Parameters:

    fileExistsBehavior - Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    See Also:

    FileExistsBehavior

  • withFileExistsBehavior

    public CreateDeploymentRequest withFileExistsBehavior(FileExistsBehavior fileExistsBehavior)

    Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Parameters:

    fileExistsBehavior - Information about how CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

    The fileExistsBehavior parameter takes any of the following values:

    • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

    • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

    • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    FileExistsBehavior

  • setOverrideAlarmConfiguration

    public void setOverrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration)

    Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

    If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

    Parameters:

    overrideAlarmConfiguration - Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

    If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

  • getOverrideAlarmConfiguration

    public AlarmConfiguration getOverrideAlarmConfiguration()

    Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

    If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

    Returns:

    Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

    If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

  • withOverrideAlarmConfiguration

    public CreateDeploymentRequest withOverrideAlarmConfiguration(AlarmConfiguration overrideAlarmConfiguration)

    Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

    If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

    Parameters:

    overrideAlarmConfiguration - Allows you to specify information about alarms associated with a deployment. The alarm configuration that you specify here will override the alarm configuration at the deployment group level. Consider overriding the alarm configuration if you have set up alarms at the deployment group level that are causing deployment failures. In this case, you would call CreateDeployment to create a new deployment that uses a previous application revision that is known to work, and set its alarm configuration to turn off alarm polling. Turning off alarm polling ensures that the new deployment proceeds without being blocked by the alarm that was generated by the previous, failed, deployment.

    If you specify an overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission when calling CreateDeployment.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public CreateDeploymentRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()