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

Create, Update and Delete Amazon Inspector Assessment Targets

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

Authors: Dennis Conrad (@dennisconrad)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Creates, updates, or deletes Amazon Inspector Assessment Targets and manages the required Resource Groups.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create my_target Assessment Target
  aws_inspector_target:
    name: my_target
    tags:
      role: scan_target
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update Existing my_target Assessment Target with Additional Tags
  aws_inspector_target:
    name: my_target
    tags:
      env: dev
      role: scan_target
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete my_target Assessment Target
  aws_inspector_target:
    name: my_target
    state: absent

Inputs

    
name:
    description:
    - The user-defined name that identifies the assessment target.  The name must be unique
      within the AWS account.
    required: true

tags:
    description:
    - Tags of the EC2 instances to be added to the assessment target.
    - Required if C(state=present).

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the assessment target.

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

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

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

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

arn:
  description: The ARN that specifies the Amazon Inspector assessment target.
  returned: success
  sample: arn:aws:inspector:eu-west-1:123456789012:target/0-O4LnL7n1
  type: str
created_at:
  description: The time at which the assessment target was created.
  returned: success
  sample: '2018-01-29T13:48:51.958000+00:00'
  type: str
name:
  description: The name of the Amazon Inspector assessment target.
  returned: success
  sample: my_target
  type: str
resource_group_arn:
  description: The ARN that specifies the resource group that is associated with the
    assessment target.
  returned: success
  sample: arn:aws:inspector:eu-west-1:123456789012:resourcegroup/0-qY4gDel8
  type: str
tags:
  description: The tags of the resource group that is associated with the assessment
    target.
  returned: success
  sample:
    env: dev
    role: scan_target
  type: list
updated_at:
  description: The time at which the assessment target was last updated.
  returned: success
  sample: '2018-01-29T13:48:51.958000+00:00'
  type: str