community / community.aws / 3.4.0 / module / aws_codepipeline Create or delete AWS CodePipelines | "added in version" 1.0.0 of community.aws" Authors: Stefan Horning (@stefanhorning) <horning@mediapeers.com>community.aws.aws_codepipeline (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Create or delete a CodePipeline on AWS.
# 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
name: description: - Name of the pipeline required: true type: str state: choices: - present - absent default: present description: - Create or remove code pipeline type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str stages: description: - List of stages to perform in the CodePipeline. List of dictionaries containing name and actions for each stage. elements: dict required: true suboptions: actions: description: - List of action configurations for that stage. - 'See the boto3 documentation for full documentation of suboptions:' - U(https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codepipeline.html#CodePipeline.Client.create_pipeline) elements: dict type: list name: description: - Name of the stage (step) in the codepipeline type: str type: list ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str version: description: - Version number of the pipeline. This number is automatically incremented when a pipeline is updated. required: false type: int role_arn: description: - ARN of the IAM role to use when executing the pipeline required: true type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path artifact_store: description: - Location information where artifacts are stored (on S3). Dictionary with fields type and location. required: true suboptions: location: description: - Bucket name for artifacts. type: str type: description: - Type of the artifacts storage (only 'S3' is currently supported). type: str type: dict aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
pipeline: contains: artifact_store: contains: encryption_key: description: The encryption key used to encrypt the artifacts store, such as an AWS KMS key. returned: when configured type: str location: description: The location of the artifacts storage (s3 bucket name) returned: always sample: my_s3_codepipline_bucket type: str type: description: The type of the artifacts store, such as S3 returned: always sample: S3 type: str description: Information about where the build artifacts are stored returned: always type: complex name: description: Name of the CodePipeline returned: always sample: my_deploy_pipeline type: str role_arn: description: ARN of the IAM role attached to the code pipeline returned: always sample: arn:aws:iam::123123123:role/codepipeline-service-role type: str stages: description: List of stages configured for this pipeline returned: always type: list version: description: The version number of the pipeline. This number is auto incremented when pipeline params are changed. returned: always type: int description: Returns the dictionary describing the code pipeline configuration. returned: success type: complex