community.aws.aws_codecommit (4.3.0) — module

Manage repositories in AWS CodeCommit

| "added in version" 1.0.0 of community.aws"

Authors: Shuang Wang (@ptux)

Install collection

Install with ansible-galaxy collection install community.aws:==4.3.0


Add to requirements.yml

  collections:
    - name: community.aws
      version: 4.3.0

Description

Supports creation and deletion of CodeCommit repositories.

See U(https://aws.amazon.com/codecommit/) for more information about CodeCommit.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a new repository
- community.aws.aws_codecommit:
    name: repo
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Delete a repository
- community.aws.aws_codecommit:
    name: repo
    state: absent

Inputs

    
name:
    description:
    - name of repository.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Specifies the state of repository.
    required: true
    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

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:
    - Uses a boto profile. Only works with boto >= 2.24.0.
    - 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

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

description:
    aliases:
    - comment
    description:
    - description or comment of repository.
    required: false
    type: str

aws_ca_bundle:
    description:
    - 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.'
    type: path

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - 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 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:
    - 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 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:
    - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0.
    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

Outputs

repository_metadata:
  contains:
    account_id:
      description: The ID of the AWS account associated with the repository.
      returned: when state is present
      sample: '268342293637'
      type: str
    arn:
      description: The Amazon Resource Name (ARN) of the repository.
      returned: when state is present
      sample: arn:aws:codecommit:ap-northeast-1:268342293637:username
      type: str
    clone_url_http:
      description: 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
      type: str
    clone_url_ssh:
      description: 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
      type: str
    creation_date:
      description: 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'
      type: str
    last_modified_date:
      description: 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'
      type: str
    repository_description:
      description: A comment or description about the repository.
      returned: when state is present
      sample: test from ptux
      type: str
    repository_id:
      description: The ID of the repository that was created or deleted
      returned: always
      sample: e62a5c54-i879-497b-b62f-9f99e4ebfk8e
      type: str
    repository_name:
      description: The repository's name.
      returned: when state is present
      sample: reponame
      type: str
  description: Information about the repository.
  returned: always
  type: complex
response_metadata:
  contains:
    http_headers:
      description: http headers of http response
      returned: always
      type: dict
    http_status_code:
      description: http status code of http response
      returned: always
      sample: '200'
      type: str
    request_id:
      description: http request id
      returned: always
      sample: fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef
      type: str
    retry_attempts:
      description: numbers of retry attempts
      returned: always
      sample: '0'
      type: str
  description: Information about the response.
  returned: always
  type: complex