Skip to content

Update Pipeline

codepipeline_update_pipeline R Documentation

Updates a specified pipeline with edits or changes to its structure

Description

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and update_pipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Usage

codepipeline_update_pipeline(pipeline)

Arguments

pipeline

[required] The name of the pipeline to be updated.

Value

A list with the following syntax:

list(
  pipeline = list(
    name = "string",
    roleArn = "string",
    artifactStore = list(
      type = "S3",
      location = "string",
      encryptionKey = list(
        id = "string",
        type = "KMS"
      )
    ),
    artifactStores = list(
      list(
        type = "S3",
        location = "string",
        encryptionKey = list(
          id = "string",
          type = "KMS"
        )
      )
    ),
    stages = list(
      list(
        name = "string",
        blockers = list(
          list(
            name = "string",
            type = "Schedule"
          )
        ),
        actions = list(
          list(
            name = "string",
            actionTypeId = list(
              category = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval",
              owner = "AWS"|"ThirdParty"|"Custom",
              provider = "string",
              version = "string"
            ),
            runOrder = 123,
            configuration = list(
              "string"
            ),
            outputArtifacts = list(
              list(
                name = "string"
              )
            ),
            inputArtifacts = list(
              list(
                name = "string"
              )
            ),
            roleArn = "string",
            region = "string",
            namespace = "string",
            timeoutInMinutes = 123
          )
        ),
        onFailure = list(
          result = "ROLLBACK"|"FAIL",
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        ),
        onSuccess = list(
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        ),
        beforeEntry = list(
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        )
      )
    ),
    version = 123,
    executionMode = "QUEUED"|"SUPERSEDED"|"PARALLEL",
    pipelineType = "V1"|"V2",
    variables = list(
      list(
        name = "string",
        defaultValue = "string",
        description = "string"
      )
    ),
    triggers = list(
      list(
        providerType = "CodeStarSourceConnection",
        gitConfiguration = list(
          sourceActionName = "string",
          push = list(
            list(
              tags = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              branches = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              filePaths = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              )
            )
          ),
          pullRequest = list(
            list(
              events = list(
                "OPEN"|"UPDATED"|"CLOSED"
              ),
              branches = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              filePaths = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              )
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$update_pipeline(
  pipeline = list(
    name = "string",
    roleArn = "string",
    artifactStore = list(
      type = "S3",
      location = "string",
      encryptionKey = list(
        id = "string",
        type = "KMS"
      )
    ),
    artifactStores = list(
      list(
        type = "S3",
        location = "string",
        encryptionKey = list(
          id = "string",
          type = "KMS"
        )
      )
    ),
    stages = list(
      list(
        name = "string",
        blockers = list(
          list(
            name = "string",
            type = "Schedule"
          )
        ),
        actions = list(
          list(
            name = "string",
            actionTypeId = list(
              category = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval",
              owner = "AWS"|"ThirdParty"|"Custom",
              provider = "string",
              version = "string"
            ),
            runOrder = 123,
            configuration = list(
              "string"
            ),
            outputArtifacts = list(
              list(
                name = "string"
              )
            ),
            inputArtifacts = list(
              list(
                name = "string"
              )
            ),
            roleArn = "string",
            region = "string",
            namespace = "string",
            timeoutInMinutes = 123
          )
        ),
        onFailure = list(
          result = "ROLLBACK"|"FAIL",
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        ),
        onSuccess = list(
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        ),
        beforeEntry = list(
          conditions = list(
            list(
              result = "ROLLBACK"|"FAIL",
              rules = list(
                list(
                  name = "string",
                  ruleTypeId = list(
                    category = "Rule",
                    owner = "AWS",
                    provider = "string",
                    version = "string"
                  ),
                  configuration = list(
                    "string"
                  ),
                  inputArtifacts = list(
                    list(
                      name = "string"
                    )
                  ),
                  roleArn = "string",
                  region = "string",
                  timeoutInMinutes = 123
                )
              )
            )
          )
        )
      )
    ),
    version = 123,
    executionMode = "QUEUED"|"SUPERSEDED"|"PARALLEL",
    pipelineType = "V1"|"V2",
    variables = list(
      list(
        name = "string",
        defaultValue = "string",
        description = "string"
      )
    ),
    triggers = list(
      list(
        providerType = "CodeStarSourceConnection",
        gitConfiguration = list(
          sourceActionName = "string",
          push = list(
            list(
              tags = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              branches = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              filePaths = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              )
            )
          ),
          pullRequest = list(
            list(
              events = list(
                "OPEN"|"UPDATED"|"CLOSED"
              ),
              branches = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              ),
              filePaths = list(
                includes = list(
                  "string"
                ),
                excludes = list(
                  "string"
                )
              )
            )
          )
        )
      )
    )
  )
)