community / community.aws / 5.1.0 / module / ecs_ecr Manage Elastic Container Registry repositories | "added in version" 1.0.0 of community.aws" Authors: David M. Lee (@leedm777)community.aws.ecs_ecr (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Manage Elastic Container Registry repositories.
# If the repository does not exist, it is created. If it does exist, would not # affect any policies already on it. - name: ecr-repo community.aws.ecs_ecr: name: super/cool
- name: destroy-ecr-repo community.aws.ecs_ecr: name: old/busted state: absent
- name: Cross account ecr-repo community.aws.ecs_ecr: registry_id: 123456789012 name: cross/account
- name: set-policy as object community.aws.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
- name: set-policy as string community.aws.ecs_ecr: name: needs-policy-string policy: "{{ lookup('template', 'policy.json.j2') }}"
- name: delete-policy community.aws.ecs_ecr: name: needs-no-policy purge_policy: true
- name: create immutable ecr-repo community.aws.ecs_ecr: name: super/cool image_tag_mutability: immutable
- name: set-lifecycle-policy community.aws.ecs_ecr: name: needs-lifecycle-policy scan_on_push: true lifecycle_policy: rules: - rulePriority: 1 description: new policy selection: tagStatus: untagged countType: sinceImagePushed countUnit: days countNumber: 365 action: type: expire
- name: purge-lifecycle-policy community.aws.ecs_ecr: name: needs-no-lifecycle-policy purge_lifecycle_policy: true
name: description: - The name of the repository. required: true type: str state: choices: - present - absent default: present description: - Create or destroy the repository. required: false type: str policy: description: - JSON or dict that represents the new policy. required: false type: json 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 registry_id: description: - AWS account id associated with the registry. - If not specified, the default registry is assumed. 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 force_absent: default: false description: - If I(force_absent=true), the repository will be removed, even if images are present. required: false type: bool version_added: 4.1.0 version_added_collection: community.aws purge_policy: description: - If C(true), remove the policy from the repository. - Defaults to C(false). required: false type: bool scan_on_push: default: false description: - if C(true), images are scanned for known vulnerabilities after being pushed to the repository. required: false type: bool version_added: 1.3.0 version_added_collection: community.aws 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 force_set_policy: default: false description: - If I(force_set_policy=false), it prevents setting a policy that would prevent you from setting another policy in the future. required: false type: bool lifecycle_policy: description: - JSON or dict that represents the new lifecycle policy. required: false type: json image_tag_mutability: choices: - mutable - immutable default: mutable description: - Configure whether repository should be mutable (ie. an already existing tag can be overwritten) or not. required: false type: str purge_lifecycle_policy: description: - if C(true), remove the lifecycle policy from the repository. - Defaults to C(false). required: false 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
created: description: If true, the repository was created returned: always type: bool name: description: The name of the repository returned: I(state=absent) type: str policy: description: The existing, created or updated repository policy. returned: I(state=present) type: dict version_added: 4.0.0 version_added_collection: community.aws repository: description: The created or updated repository returned: I(state=present) sample: createdAt: '2017-01-17T08:41:32-06:00' registryId: '123456789012' repositoryArn: arn:aws:ecr:us-east-1:123456789012:repository/ecr-test-1484664090 repositoryName: ecr-test-1484664090 repositoryUri: 123456789012.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