Try SpotterCreate and manage DB proxies
| "added in version" 0.1.0 of amazon.cloud"
Authors: Ansible Cloud Team (@ansible-collections)
Install with ansible-galaxy collection install amazon.cloud:==0.4.0
collections:
- name: amazon.cloud
version: 0.4.0Creates and manage DB proxies.
auth:
description:
- The authorization mechanism that the proxy uses.
elements: dict
suboptions:
auth_scheme:
choices:
- SECRETS
description:
- The type of authentication that the proxy uses for connections from the proxy
to the underlying database.
type: str
client_password_auth_type:
choices:
- MYSQL_NATIVE_PASSWORD
- POSTGRES_MD5
- POSTGRES_SCRAM_SHA_256
- SQL_SERVER_AUTHENTICATION
description:
- The type of authentication the proxy uses for connections from clients.
type: str
description:
description:
- A user-specified description about the authentication used by a proxy to log
in as a specific database user.
type: str
iam_auth:
choices:
- DISABLED
- ENABLED
- REQUIRED
description:
- Whether to require or disallow Amazon Web Services Identity and Access Management
(IAM) authentication for connections to the proxy.
- The C(ENABLED) value is valid only for proxies with RDS for Microsoft SQL Server.
type: str
secret_arn:
description:
- The Amazon Resource Name (ARN) representing the secret that the proxy uses to
authenticate to the RDS DB instance or Aurora DB cluster.
- These secrets are stored within Amazon Secrets Manager.
type: str
type: list
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).
type: dict
wait:
default: false
description:
- Wait for operation to complete before returning.
type: bool
force:
default: false
description:
- Cancel IN_PROGRESS and PENDING resource requestes.
- Because you can only perform a single operation on a given resource at a time, there
might be cases where you need to cancel the current resource operation to make the
resource available so that another operation may be performed on it.
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.
- 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
role_arn:
description:
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets
in AWS Secrets Manager.
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
purge_tags:
default: true
description:
- Remove tags not listed in I(tags).
type: bool
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
require_tls:
description:
- A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption
is required for connections to the proxy.
type: bool
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
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.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
db_proxy_name:
description:
- The identifier for the proxy.
- This name must be unique for all proxies owned by your AWS account in the specified
AWS Region.
type: str
debug_logging:
description:
- Whether the proxy includes detailed information about SQL statements in its logs.
type: bool
engine_family:
choices:
- MYSQL
- POSTGRESQL
- SQLSERVER
description:
- The kinds of databases that the proxy can connect to.
type: str
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
vpc_subnet_ids:
description:
- VPC subnet IDs to associate with the new proxy.
elements: str
type: list
idle_client_timeout:
description:
- The number of seconds that a connection to the proxy can be inactive before the
proxy disconnects it.
type: int
vpc_security_group_ids:
description:
- VPC security group IDs to associate with the new proxy.
elements: str
type: list
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
result:
contains:
identifier:
description: The unique identifier of the resource.
type: str
properties:
description: The resource properties.
type: dict
description:
- When I(state=list), it is a list containing dictionaries of resource information.
- Otherwise, it is a dictionary of resource information.
- When I(state=absent), it is an empty dictionary.
returned: always
type: complex