community.aws.codecommit_repository (5.1.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:==5.1.0


Add to requirements.yml

  collections:
    - name: community.aws
      version: 5.1.0

Description

Supports creation and deletion of CodeCommit repositories.

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

Prior to release 5.0.0 this module was called C(community.aws.aws_codecommit). The usage did not change.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a new repository
- community.aws.codecommit_repository:
    name: repo
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Delete a repository
- community.aws.codecommit_repository:
    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.
    - For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
    - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
    - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
    - The C(ec2_region) alias has been deprecated and will be removed in a release after
      2024-12-01
    - Support for the C(EC2_REGION) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - A named AWS profile to use for authentication.
    - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
    - The C(AWS_PROFILE) environment variable may also be used.
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

access_key:
    aliases:
    - aws_access_key_id
    - aws_access_key
    - ec2_access_key
    description:
    - AWS access key ID.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
      may also be used in decreasing order of preference.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
      AWS botocore SDK.
    - The I(ec2_access_key) alias has been deprecated and will be removed in a release
      after 2024-12-01.
    - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
    type: dict

secret_key:
    aliases:
    - aws_secret_access_key
    - aws_secret_key
    - ec2_secret_key
    description:
    - AWS secret access key.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
      variables may also be used in decreasing order of preference.
    - The I(secret_key) and I(profile) options are mutually exclusive.
    - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
      the AWS botocore SDK.
    - The I(ec2_secret_key) alias has been deprecated and will be removed in a release
      after 2024-12-01.
    - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

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

endpoint_url:
    aliases:
    - ec2_url
    - aws_endpoint_url
    - s3_url
    description:
    - URL to connect to instead of the default AWS endpoints.  While this can be used
      to connection to other AWS-compatible services the amazon.aws and community.aws
      collections are only tested against AWS.
    - The  C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
      order of preference.
    - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
      a release after 2024-12-01.
    - Support for the C(EC2_URL) environment variable has been deprecated and will be
      removed in a release after 2024-12-01.
    type: str

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - The C(AWS_CA_BUNDLE) environment variable may also be used.
    type: path

session_token:
    aliases:
    - aws_session_token
    - security_token
    - aws_security_token
    - access_token
    description:
    - AWS STS session token for use with temporary credentials.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
      variables may also be used in decreasing order of preference.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
      the parameter being renamed from I(security_token) to I(session_token) in release
      6.0.0.
    - The I(security_token), I(aws_security_token), and I(access_token) aliases have been
      deprecated and will be removed in a release after 2024-12-01.
    - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
      has been deprecated and will be removed in a release after 2024-12-01.
    type: str

validate_certs:
    default: true
    description:
    - When set to C(false), SSL certificates will not be validated for communication with
      the AWS APIs.
    - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
      setting I(aws_ca_bundle) instead.
    type: bool

debug_botocore_endpoint_logs:
    default: false
    description:
    - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
      API calls made during a task, outputing the set to the resource_actions key in the
      task results. Use the C(aws_resource_action) callback to output to total list made
      during a playbook.
    - The C(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: '123456789012'
      type: str
    arn:
      description: The Amazon Resource Name (ARN) of the repository.
      returned: when state is present
      sample: arn:aws:codecommit:ap-northeast-1:123456789012: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