community.aws.aws_codecommit – Manage repositories in AWS CodeCommit

Note

This plugin is part of the community.aws collection (version 1.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.aws_codecommit.

New in version 1.0.0: of community.aws

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto

  • boto3

  • botocore

  • python >= 2.6

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, 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.

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

aliases: ec2_secret_key, 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.

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.

Choices:

  • no ← (default)

  • yes

description

aliases: comment

string

description or comment of repository.

ec2_url

aliases: aws_endpoint_url, endpoint_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.

name

string / required

name of repository.

profile

aliases: aws_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.

region

aliases: aws_region, ec2_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

security_token

aliases: aws_security_token, access_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.

state

string / required

Specifies the state of repository.

Choices:

  • present

  • absent

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_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_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# Create a new repository
- community.aws.aws_codecommit:
    name: repo
    state: present

# Delete a repository
- community.aws.aws_codecommit:
    name: repo
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

repository_metadata

complex

Information about the repository.

Returned: always

account_id

string

The ID of the AWS account associated with the repository.

Returned: when state is present

Sample: “268342293637”

arn

string

The Amazon Resource Name (ARN) of the repository.

Returned: when state is present

Sample: “arn:aws:codecommit:ap-northeast-1:268342293637:username”

clone_url_http

string

The URL to use for cloning the repository over HTTPS.

Returned: when state is present

Sample: “https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame”

clone_url_ssh

string

The URL to use for cloning the repository over SSH.

Returned: when state is present

Sample: “ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame”

creation_date

string

The date and time the repository was created, in timestamp format.

Returned: when state is present

Sample: “2018-10-16T13:21:41.261000+09:00”

last_modified_date

string

The date and time the repository was last modified, in timestamp format.

Returned: when state is present

Sample: “2018-10-16T13:21:41.261000+09:00”

repository_description

string

A comment or description about the repository.

Returned: when state is present

Sample: “test from ptux”

repository_id

string

The ID of the repository that was created or deleted

Returned: always

Sample: “e62a5c54-i879-497b-b62f-9f99e4ebfk8e”

repository_name

string

The repository’s name.

Returned: when state is present

Sample: “reponame”

response_metadata

complex

Information about the response.

Returned: always

http_headers

dictionary

http headers of http response

Returned: always

http_status_code

string

http status code of http response

Returned: always

Sample: “200”

request_id

string

http request id

Returned: always

Sample: “fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef”

retry_attempts

string

numbers of retry attempts

Returned: always

Sample: “0”

Authors

  • Shuang Wang (@ptux)