Try SpotterCreate and manage frameworks with one or more controls
| "added in version" 0.1.0 of amazon.cloud"
Authors: Ansible Cloud Team (@ansible-collections)
Install with ansible-galaxy collection install amazon.cloud:==0.1.0
collections:
- name: amazon.cloud
version: 0.1.0Creates and manages frameworks with one or more controls (list, create, update, describe, delete).
tags:
aliases:
- resource_tags
description:
- A dict of tags to apply to the resource.
- To remove all tags set I(tags={}) and I(purge_tags=true).
required: false
type: dict
wait:
default: false
description:
- Wait for operation to complete before returning.
type: bool
state:
choices:
- present
- absent
- list
- describe
- get
default: present
description:
- Goal state for resource.
- I(state=present) creates the resource if it doesn't exist, or updates to the provided
state if the resource already exists.
- I(state=absent) ensures an existing instance is deleted.
- I(state=list) get all the existing resources.
- I(state=describe) or I(state=get) retrieves information on an existing resource.
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:
- 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).
type: dict
purge_tags:
default: true
description:
- Remove tags not listed in I(tags).
required: false
type: bool
wait_timeout:
default: 320
description:
- How many seconds to wait for an operation to complete before timing out.
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
framework_arn:
description:
- An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
type: str
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
framework_name:
description:
- The unique name of a framework.
- This name is between 1 and 256 characters, starting with a letter, and consisting
of letters (a-z, A-Z), numbers (0-9), and underscores (_).
type: str
framework_tags:
description:
- A key-value pair to associate with a resource.
elements: dict
suboptions:
key:
description:
- The key name of the tag.
- You can specify a value that is 1 to 128 Unicode characters in length and cannot
be prefixed with aws:.
- 'You can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -.'
required: true
type: str
value:
description:
- The value for the tag.
- You can specify a value that is 0 to 256 Unicode characters in length and cannot
be prefixed with aws:.
- 'You can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -.'
required: true
type: str
type: list
security_token:
aliases:
- aws_session_token
- session_token
- 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.
- Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
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
framework_controls:
description:
- Contains detailed information about all of the controls of a framework.
- Each framework must contain at least one control.
elements: dict
required: true
suboptions:
control_input_parameters:
description:
- A list of I(parameter_name) and I(parameter_value) pairs.
elements: dict
suboptions:
parameter_name:
description:
- Not Provived.
required: true
type: str
parameter_value:
description:
- Not Provived.
required: true
type: str
type: list
control_name:
description:
- The name of a control.
- This name is between 1 and 256 characters.
required: true
type: str
control_scope:
description:
- The scope of a control.
- The control scope defines what the control will evaluate.
- 'Three examples of control scopes are: a specific backup plan, all backup plans
with a specific tag, or all backup plans.'
suboptions:
compliance_resource_ids:
description:
- The ID of the only AWS resource that you want your control scope to contain.
elements: str
type: list
compliance_resource_types:
description:
- Describes whether the control scope includes one or more types of resources,
such as `EFS` or `RDS`.
elements: str
type: list
tags:
description:
- A key-value pair to associate with a resource.
elements: dict
suboptions:
key:
description:
- The key name of the tag.
- You can specify a value that is 1 to 128 Unicode characters in length
and cannot be prefixed with aws:.
- 'You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -.'
required: true
type: str
value:
description:
- The value for the tag.
- You can specify a value that is 0 to 256 Unicode characters in length
and cannot be prefixed with aws:.
- 'You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -.'
required: true
type: str
type: list
type: dict
type: list
framework_description:
description:
- An optional description of the framework with a maximum 1,024 characters.
type: str
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
result:
contains:
identifier:
description: The unique identifier of the resource.
type: str
properties:
description: The resource properties.
type: dict
description: Dictionary containing resource information.
returned: always
type: complex