Package software.amazon.awscdk.services.codepipeline.actions

Class CodeDeployEcsDeployActionProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.codepipeline.actions.CodeDeployEcsDeployActionProps.Jsii$Proxy
All Implemented Interfaces:
CodeDeployEcsDeployActionProps, CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CodeDeployEcsDeployActionProps
@Stability(Stable) @Internal public static final class CodeDeployEcsDeployActionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CodeDeployEcsDeployActionProps
An implementation for CodeDeployEcsDeployActionProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CodeDeployEcsDeployActionProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CodeDeployEcsDeployActionProps.Builder.

  • Method Details

    • getDeploymentGroup

      public final IEcsDeploymentGroup getDeploymentGroup()
      Description copied from interface: CodeDeployEcsDeployActionProps
      The CodeDeploy ECS Deployment Group to deploy to.
      Specified by:
      getDeploymentGroup in interface CodeDeployEcsDeployActionProps

    • getAppSpecTemplateFile

      public final ArtifactPath getAppSpecTemplateFile()
      Description copied from interface: CodeDeployEcsDeployActionProps
      The name of the CodeDeploy AppSpec file.

      During deployment, a new task definition will be registered with ECS, and the new task definition ID will be inserted into the CodeDeploy AppSpec file. The AppSpec file contents will be provided to CodeDeploy for the deployment.

      Use this property if you want to use a different name for this file than the default 'appspec.yaml'. If you use this property, you don't need to specify the appSpecTemplateInput property.

      Default: - one of this property, or `appSpecTemplateInput`, is required

      Specified by:
      getAppSpecTemplateFile in interface CodeDeployEcsDeployActionProps

    • getAppSpecTemplateInput

      public final Artifact getAppSpecTemplateInput()
      Description copied from interface: CodeDeployEcsDeployActionProps
      The artifact containing the CodeDeploy AppSpec file.

      During deployment, a new task definition will be registered with ECS, and the new task definition ID will be inserted into the CodeDeploy AppSpec file. The AppSpec file contents will be provided to CodeDeploy for the deployment.

      If you use this property, it's assumed the file is called 'appspec.yaml'. If your AppSpec file uses a different filename, leave this property empty, and use the appSpecTemplateFile property instead.

      Default: - one of this property, or `appSpecTemplateFile`, is required

      Specified by:
      getAppSpecTemplateInput in interface CodeDeployEcsDeployActionProps

    • getContainerImageInputs

      public final List<CodeDeployEcsContainerImageInput> getContainerImageInputs()
      Description copied from interface: CodeDeployEcsDeployActionProps
      Configuration for dynamically updated images in the task definition.

      Provide pairs of an image details input artifact and a placeholder string that will be used to dynamically update the ECS task definition template file prior to deployment. A maximum of 4 images can be given.

      Specified by:
      getContainerImageInputs in interface CodeDeployEcsDeployActionProps

    • getTaskDefinitionTemplateFile

      public final ArtifactPath getTaskDefinitionTemplateFile()
      Description copied from interface: CodeDeployEcsDeployActionProps
      The name of the ECS task definition template file.

      During deployment, the task definition template file contents will be registered with ECS.

      Use this property if you want to use a different name for this file than the default 'taskdef.json'. If you use this property, you don't need to specify the taskDefinitionTemplateInput property.

      Default: - one of this property, or `taskDefinitionTemplateInput`, is required

      Specified by:
      getTaskDefinitionTemplateFile in interface CodeDeployEcsDeployActionProps

    • getTaskDefinitionTemplateInput

      public final Artifact getTaskDefinitionTemplateInput()
      Description copied from interface: CodeDeployEcsDeployActionProps
      The artifact containing the ECS task definition template file.

      During deployment, the task definition template file contents will be registered with ECS.

      If you use this property, it's assumed the file is called 'taskdef.json'. If your task definition template uses a different filename, leave this property empty, and use the taskDefinitionTemplateFile property instead.

      Default: - one of this property, or `taskDefinitionTemplateFile`, is required

      Specified by:
      getTaskDefinitionTemplateInput in interface CodeDeployEcsDeployActionProps

    • getRole

      public final IRole getRole()
      Description copied from interface: CommonAwsActionProps
      The Role in which context's this Action will be executing in.

      The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

      Default: a new Role will be generated

      Specified by:
      getRole in interface CommonAwsActionProps

    • getActionName

      public final String getActionName()
      Description copied from interface: CommonActionProps
      The physical, human-readable name of the Action.

      Note that Action names must be unique within a single Stage.

      Specified by:
      getActionName in interface CommonActionProps

    • getRunOrder

      public final Number getRunOrder()
      Description copied from interface: CommonActionProps
      The runOrder property for this Action.

      RunOrder determines the relative order in which multiple Actions in the same Stage execute.

      Default: 1

      Specified by:
      getRunOrder in interface CommonActionProps
      See Also:

    • getVariablesNamespace

      public final String getVariablesNamespace()
      Description copied from interface: CommonActionProps
      The name of the namespace to use for variables emitted by this action.

      Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

      Specified by:
      getVariablesNamespace in interface CommonActionProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object