community.aws.dms_replication_subnet_group 模块 – 创建或销毁数据迁移服务子网组

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定:community.aws.dms_replication_subnet_group

community.aws 1.0.0 中的新增功能

摘要

  • 创建或销毁数据迁移服务子网组。

要求

执行此模块的主机需要以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名:aws_access_key_id、aws_access_key、ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

还可以使用 AWS_ACCESS_KEY_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量,优先级依次递减。

aws_access_keyprofile 选项是互斥的。

为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已弃用,将在 2024-12-01 之后的一个版本中删除。

EC2_ACCESS_KEY 环境变量的支持已弃用,将在 2024-12-01 之后的一个版本中删除。

aws_ca_bundle

路径

验证 SSL 证书时要使用的 CA 捆绑包的位置。

还可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 日志记录器来解析在任务期间执行的唯一(而不是总计)"resource:action" API 调用,并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间执行的总列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

description

字符串 / 必需

子网组的描述。

endpoint_url

别名:ec2_url、aws_endpoint_url、s3_url

字符串

连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

还可以使用 AWS_URLEC2_URL 环境变量,优先级依次递减。

ec2_urls3_url 别名已弃用,将在 2024-12-01 之后的一个版本中删除。

EC2_URL 环境变量的支持已弃用,将在 2024-12-01 之后的一个版本中删除。

identifier

字符串 / 必需

复制子网组的名称。此值存储为小写字符串。必须包含不超过 255 个字母数字字符、句点、空格、下划线或连字符。不能为“default”。

profile

别名:aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

还可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

region

别名:aws_region、ec2_region

字符串

要使用的 AWS 区域。

对于诸如 IAM、Route53 和 CloudFront 之类的全球服务,将忽略 region

也可以使用AWS_REGIONEC2_REGION环境变量。

更多信息请参见Amazon AWS文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

ec2_region别名已弃用,将在2024年12月1日后的某个版本中移除。

EC2_REGION环境变量的支持已弃用,将在2024年12月1日后的某个版本中移除。

secret_key

别名:aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS密钥访问密钥。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

也可以使用AWS_SECRET_ACCESS_KEYAWS_SECRET_KEYEC2_SECRET_KEY环境变量,优先级依次递减。

secret_keyprofile选项互斥。

aws_secret_access_key别名在5.1.0版本中添加,以与AWS botocore SDK保持一致。

ec2_secret_key别名已弃用,将在2024年12月1日后的某个版本中移除。

EC2_SECRET_KEY环境变量的支持已弃用,将在2024年12月1日后的某个版本中移除。

session_token

别名:aws_session_token, security_token, aws_security_token, access_token

字符串

用于临时凭证的AWS STS会话令牌。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

也可以使用AWS_SESSION_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN环境变量,优先级依次递减。

security_tokenprofile选项互斥。

别名aws_session_tokensession_token在3.2.0版本中添加,参数名称在6.0.0版本中从security_token更改为session_token

security_tokenaws_security_tokenaccess_token别名已弃用,将在2024年12月1日后的某个版本中移除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN环境变量的支持已弃用,将在2024年12月1日后的某个版本中移除。

state

字符串

子网组的状态。

选项

  • "present" ← (默认)

  • "absent"

subnet_ids

列表 / 元素=字符串 / 必填

包含复制子网组子网ID的列表,列表中至少需要2个项目。

validate_certs

布尔值

设置为false时,将不会验证与AWS API通信的SSL证书。

强烈建议不要设置validate_certs=false,可以考虑改用aws_ca_bundle

选项

  • false

  • true ← (默认)

注释

注意

  • 警告:对于模块,环境变量和配置文件是从Ansible的“主机”上下文而不是“控制器”上下文读取的。因此,可能需要将文件显式复制到“主机”。对于查找和连接插件,环境变量和配置文件是从Ansible的“控制器”上下文而不是“主机”上下文读取的。

  • Ansible使用的AWS SDK (boto3)也可能从其在Ansible“主机”上下文中的配置文件(通常为~/.aws/credentials)读取凭据和其他设置的默认值,例如区域。更多信息请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

示例

- community.aws.dms_replication_subnet_group:
    state: present
    identifier: "dev-sngroup"
    description: "Development Subnet Group asdasdas"
    subnet_ids: ['subnet-id1', 'subnet-id2']

作者

  • Rui Moreira (@ruimoreira)