ansible.builtin.ecs_ecr (v2.9.17) — module

Manage Elastic Container Registry repositories

| "added in version" 2.3 of ansible.builtin"

Authors: David M. Lee (@leedm777)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Manage Elastic Container Registry repositories


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# If the repository does not exist, it is created. If it does exist, would not
# affect any policies already on it.
- name: ecr-repo
  ecs_ecr: name=super/cool
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: destroy-ecr-repo
  ecs_ecr: name=old/busted state=absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Cross account ecr-repo
  ecs_ecr: registry_id=999999999999 name=cross/account
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: set-policy as object
  ecs_ecr:
    name: needs-policy-object
    policy:
      Version: '2008-10-17'
      Statement:
        - Sid: read-only
          Effect: Allow
          Principal:
            AWS: '{{ read_only_arn }}'
          Action:
            - ecr:GetDownloadUrlForLayer
            - ecr:BatchGetImage
            - ecr:BatchCheckLayerAvailability
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: set-policy as string
  ecs_ecr:
    name: needs-policy-string
    policy: "{{ lookup('template', 'policy.json.j2') }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete-policy
  ecs_ecr:
    name: needs-no-policy
    delete_policy: yes

Inputs

    
name:
    description:
    - the name of the repository
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - create or destroy the repository
    required: false

policy:
    description:
    - JSON or dict that represents the new policy
    required: false

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:
    - 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

registry_id:
    description:
    - AWS account id associated with the registry.
    - If not specified, the default registry is assumed.
    required: false

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

delete_policy:
    default: false
    description:
    - if yes, remove the policy from the repository
    required: false
    type: bool

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

force_set_policy:
    default: false
    description:
    - if no, prevents setting a policy that would prevent you from setting another policy
      in the future.
    required: false
    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

created:
  description: If true, the repository was created
  returned: always
  type: bool
name:
  description: The name of the repository
  returned: when state == 'absent'
  type: str
repository:
  description: The created or updated repository
  returned: when state == 'present'
  sample:
    createdAt: '2017-01-17T08:41:32-06:00'
    registryId: '999999999999'
    repositoryArn: arn:aws:ecr:us-east-1:999999999999:repository/ecr-test-1484664090
    repositoryName: ecr-test-1484664090
    repositoryUri: 999999999999.dkr.ecr.us-east-1.amazonaws.com/ecr-test-1484664090
  type: dict
state:
  description: The asserted state of the repository (present, absent)
  returned: always
  type: str