JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.codepipeline.model

Class PipelineDeclaration

    • Constructor Detail

      • PipelineDeclaration

        public PipelineDeclaration()
    • Method Detail

      • setName

        public void setName(String name)

        The name of the pipeline.

        Parameters:
        name - The name of the pipeline.
      • getName

        public String getName()

        The name of the pipeline.

        Returns:
        The name of the pipeline.
      • withName

        public PipelineDeclaration withName(String name)

        The name of the pipeline.

        Parameters:
        name - The name of the pipeline.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRoleArn

        public void setRoleArn(String roleArn)

        The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
      • getRoleArn

        public String getRoleArn()

        The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

        Returns:
        The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
      • withRoleArn

        public PipelineDeclaration withRoleArn(String roleArn)

        The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setArtifactStore

        public void setArtifactStore(ArtifactStore artifactStore)

        Represents information about the S3 bucket where artifacts are stored for the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

        Parameters:
        artifactStore - Represents information about the S3 bucket where artifacts are stored for the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • getArtifactStore

        public ArtifactStore getArtifactStore()

        Represents information about the S3 bucket where artifacts are stored for the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

        Returns:
        Represents information about the S3 bucket where artifacts are stored for the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • withArtifactStore

        public PipelineDeclaration withArtifactStore(ArtifactStore artifactStore)

        Represents information about the S3 bucket where artifacts are stored for the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

        Parameters:
        artifactStore - Represents information about the S3 bucket where artifacts are stored for the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

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

        public Map<String,ArtifactStore> getArtifactStores()

        A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

        Returns:
        A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • setArtifactStores

        public void setArtifactStores(Map<String,ArtifactStore> artifactStores)

        A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

        Parameters:
        artifactStores - A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      • withArtifactStores

        public PipelineDeclaration withArtifactStores(Map<String,ArtifactStore> artifactStores)

        A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

        Parameters:
        artifactStores - A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

        You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

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

        public PipelineDeclaration clearArtifactStoresEntries()
        Removes all the entries added into ArtifactStores.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getStages

        public List<StageDeclaration> getStages()

        The stage in which to perform the action.

        Returns:
        The stage in which to perform the action.
      • setStages

        public void setStages(Collection<StageDeclaration> stages)

        The stage in which to perform the action.

        Parameters:
        stages - The stage in which to perform the action.
      • withStages

        public PipelineDeclaration withStages(Collection<StageDeclaration> stages)

        The stage in which to perform the action.

        Parameters:
        stages - The stage in which to perform the action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setVersion

        public void setVersion(Integer version)

        The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

        Parameters:
        version - The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
      • getVersion

        public Integer getVersion()

        The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

        Returns:
        The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
      • withVersion

        public PipelineDeclaration withVersion(Integer version)

        The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

        Parameters:
        version - The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setExecutionMode

        public void setExecutionMode(String executionMode)

        The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

        Parameters:
        executionMode - The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
        See Also:
        ExecutionMode
      • getExecutionMode

        public String getExecutionMode()

        The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

        Returns:
        The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
        See Also:
        ExecutionMode
      • withExecutionMode

        public PipelineDeclaration withExecutionMode(String executionMode)

        The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

        Parameters:
        executionMode - The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExecutionMode
      • withExecutionMode

        public PipelineDeclaration withExecutionMode(ExecutionMode executionMode)

        The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

        Parameters:
        executionMode - The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExecutionMode
      • setPipelineType

        public void setPipelineType(String pipelineType)

        CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        Parameters:
        pipelineType - CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        See Also:
        PipelineType
      • getPipelineType

        public String getPipelineType()

        CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        Returns:
        CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        See Also:
        PipelineType
      • withPipelineType

        public PipelineDeclaration withPipelineType(String pipelineType)

        CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        Parameters:
        pipelineType - CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PipelineType
      • withPipelineType

        public PipelineDeclaration withPipelineType(PipelineType pipelineType)

        CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        Parameters:
        pipelineType - CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

        • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

        • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

        Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

        For information about pricing for CodePipeline, see Pricing.

        For information about which type of pipeline to choose, see What type of pipeline is right for me?.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PipelineType
      • getVariables

        public List<PipelineVariableDeclaration> getVariables()

        A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

        Returns:
        A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
      • setVariables

        public void setVariables(Collection<PipelineVariableDeclaration> variables)

        A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

        Parameters:
        variables - A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
      • withVariables

        public PipelineDeclaration withVariables(PipelineVariableDeclaration... variables)

        A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

        NOTE: This method appends the values to the existing list (if any). Use setVariables(java.util.Collection) or withVariables(java.util.Collection) if you want to override the existing values.

        Parameters:
        variables - A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withVariables

        public PipelineDeclaration withVariables(Collection<PipelineVariableDeclaration> variables)

        A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

        Parameters:
        variables - A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getTriggers

        public List<PipelineTriggerDeclaration> getTriggers()

        The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

        Returns:
        The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

      • setTriggers

        public void setTriggers(Collection<PipelineTriggerDeclaration> triggers)

        The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

        Parameters:
        triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

      • withTriggers

        public PipelineDeclaration withTriggers(PipelineTriggerDeclaration... triggers)

        The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

        NOTE: This method appends the values to the existing list (if any). Use setTriggers(java.util.Collection) or withTriggers(java.util.Collection) if you want to override the existing values.

        Parameters:
        triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

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

        public PipelineDeclaration withTriggers(Collection<PipelineTriggerDeclaration> triggers)

        The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

        Parameters:
        triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

        When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

        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()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /