community.aws.aws_codepipeline – Create or delete AWS CodePipelines
Note
This plugin is part of the community.aws collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.aws.
To use it in a playbook, specify: community.aws.aws_codepipeline.
New in version 1.0.0: of community.aws
Synopsis
- Create or delete a CodePipeline on AWS.
Requirements
The below requirements are needed on the host that executes this module.
- boto
- boto3
- botocore
- python >= 2.6
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| artifact_store  dictionary / required  | Location information where artifacts are stored (on S3). Dictionary with fields type and location. | ||
| location  string  | Bucket name for artifacts. | ||
| type  string  | Type of the artifacts storage (only 'S3' is currently supported). | ||
| aws_access_key  string  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key | ||
| aws_ca_bundle  path  | The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally. | ||
| aws_config  dictionary  | A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. | ||
| aws_secret_key  string  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key | ||
| debug_botocore_endpoint_logs  boolean  | 
 | Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. | |
| ec2_url  string  | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. aliases: aws_endpoint_url, endpoint_url | ||
| name  string / required  | Name of the pipeline | ||
| profile  string  | Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. 
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile | ||
| region  string  | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
 aliases: aws_region, ec2_region | ||
| role_arn  string / required  | ARN of the IAM role to use when executing the pipeline | ||
| security_token  string  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token | ||
| stages  list / elements=dictionary / required  | List of stages to perform in the CodePipeline. List of dictionaries containing name and actions for each stage. | ||
| actions  list / elements=dictionary  | List of action configurations for that stage. See the boto3 documentation for full documentation of suboptions: | ||
| name  string  | Name of the stage (step) in the codepipeline | ||
| state  string  | 
 | Create or remove code pipeline | |
| validate_certs  boolean  | 
 | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. | |
| version  integer  | Version number of the pipeline. This number is automatically incremented when a pipeline is updated. | ||
Notes
Note
- for details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/codepipeline.html
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLE
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
- 
AWS_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Example for creating a pipeline for continuous deploy of Github code to an ECS cluster (container)
- community.aws.aws_codepipeline:
    name: my_deploy_pipeline
    role_arn: arn:aws:iam::123456:role/AWS-CodePipeline-Service
    artifact_store:
      type: S3
      location: my_s3_codepipline_bucket
    stages:
      - name: Get_source
        actions:
          -
            name: Git_pull
            actionTypeId:
              category: Source
              owner: ThirdParty
              provider: GitHub
              version: '1'
            outputArtifacts:
              - { name: my-app-source }
            configuration:
              Owner: mediapeers
              Repo: my_gh_repo
              PollForSourceChanges: 'true'
              Branch: master
              # Generate token like this:
              # https://docs.aws.amazon.com/codepipeline/latest/userguide/GitHub-rotate-personal-token-CLI.html
              # GH Link: https://github.com/settings/tokens
              OAuthToken: 'abc123def456'
            runOrder: 1
      - name: Build
        actions:
          -
            name: CodeBuild
            actionTypeId:
              category: Build
              owner: AWS
              provider: CodeBuild
              version: '1'
            inputArtifacts:
              - { name: my-app-source }
            outputArtifacts:
              - { name: my-app-build }
            configuration:
              # A project with that name needs to be setup on AWS CodeBuild already (use code_build module).
              ProjectName: codebuild-project-name
            runOrder: 1
      - name: ECS_deploy
        actions:
          -
            name: ECS_deploy
            actionTypeId:
              category: Deploy
              owner: AWS
              provider: ECS
              version: '1'
            inputArtifacts:
              - { name: vod-api-app-build }
            configuration:
              # an ECS cluster with that name needs to be setup on AWS ECS already (use ecs_cluster and ecs_service module)
              ClusterName: ecs-cluster-name
              ServiceName: ecs-cluster-service-name
              FileName: imagedefinitions.json
    region: us-east-1
    state: present
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| pipeline  complex  | success | Returns the dictionary describing the code pipeline configuration. | ||
| artifact_store  complex  | always | Information about where the build artifacts are stored | ||
| encryption_key  string  | when configured | The encryption key used to encrypt the artifacts store, such as an AWS KMS key. | ||
| location  string  | always | The location of the artifacts storage (s3 bucket name) Sample: my_s3_codepipline_bucket | ||
| type  string  | always | The type of the artifacts store, such as S3 Sample: S3 | ||
| name  string  | always | Name of the CodePipeline Sample: my_deploy_pipeline | ||
| role_arn  string  | always | ARN of the IAM role attached to the code pipeline Sample: arn:aws:iam::123123123:role/codepipeline-service-role | ||
| stages  list / elements=string  | always | List of stages configured for this pipeline | ||
| version  integer  | always | The version number of the pipeline. This number is auto incremented when pipeline params are changed. | ||
Authors
- Stefan Horning (@stefanhorning) <horning@mediapeers.com>
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_codepipeline_module.html