community.aws.sns_topic_info 模块 – sns_topic_info 模块

注意

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

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

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

要在 playbook 中使用它，请指定： community.aws.sns_topic_info。

community.aws 3.2.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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。

aws_access_key 和 profile 选项是互斥的。

为与 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

endpoint_url

别名：ec2_url，aws_endpoint_url，s3_url

字符串

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

也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。

ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。

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

profile

别名：aws_profile

字符串

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

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

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。

region

别名：aws_region，ec2_region

字符串

要使用的 AWS 区域。

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

也可以使用 AWS_REGION 或 EC2_REGION 环境变量。

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

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

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

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_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY，优先级依次递减。

secret_key 和 profile 选项互斥。

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

ec2_secret_key 别名已弃用，将在 2024-12-01 之后的一个版本中移除。

对环境变量 EC2_SECRET_KEY 的支持已弃用，将在 2024-12-01 之后的一个版本中移除。

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_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN，优先级依次递减。

security_token 和 profile 选项互斥。

在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，并在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。

security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的一个版本中移除。

对环境变量 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 的支持已弃用，将在 2024-12-01 之后的一个版本中移除。

topic_arn

字符串

要查找订阅或列出属性的 AWS SNS 主题的 ARN。

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。

示例

- name: list all the topics
  community.aws.sns_topic_info:
  register: sns_topic_list

- name: get info on specific topic
  community.aws.sns_topic_info:
    topic_arn: "{{ sns_arn }}"
  register: sns_topic_info

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

result

列表 / 元素=字符串

包含一个或所有 AWS SNS 主题详细信息的结果。

返回：成功

sns_arn

字符串

主题的 ARN。

返回：始终

示例： "arn:aws:sns:us-east-2:123456789012:my_topic_name"

sns_topic

复杂类型

SNS 主题详细信息的字典。

返回：始终

content_based_deduplication

字符串

是否设置了 content_based_deduplication

返回：始终

示例： "true"

delivery_policy

字符串

SNS 主题的投递策略。

返回：当主题由此 AWS 账户拥有时

示例： "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0, \"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false}}\n"

display_name

字符串

SNS 主题的显示名称。

返回：当主题由此 AWS 账户拥有时

示例： "My topic name"

owner

字符串

拥有该主题的 AWS 账户。

返回：当主题由此 AWS 账户拥有时

示例： "123456789012"

policy

字符串

SNS 主题的策略。

返回：当主题由此 AWS 账户拥有时

示例： "{\"Version\":\"2012-10-17\",\"Id\":\"SomePolicyId\",\"Statement\":[{\"Sid\":\"ANewSid\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"}, \"Action\":\"sns:Subscribe\",\"Resource\":\"arn:aws:sns:us-east-2:123456789012:ansible-test-dummy-topic\",\"Condition\":{\"StringEquals\":{\"sns:Protocol\":\"email\"}}}]}\n"

subscriptions

列表 / 元素=字符串

此 AWS 账户中主题的订阅者列表。

返回：始终

示例： []

subscriptions_added

列表 / 元素=字符串

此运行中添加的订阅者列表。

返回：始终

示例： []

subscriptions_confirmed

字符串

已确认的订阅数。

返回：当主题由此 AWS 账户拥有时

示例： "0"

subscriptions_deleted

字符串

已删除的订阅数。

返回：当主题由此 AWS 账户拥有时

示例： "0"

subscriptions_existing

列表 / 元素=字符串

现有订阅列表。

返回：始终

示例： []

subscriptions_new

列表 / 元素=字符串

新订阅列表。

返回：始终

示例： []

subscriptions_pending

字符串

待处理订阅数。

返回：当主题由此 AWS 账户拥有时

示例： "0"

subscriptions_purge

布尔值

是否设置了 purge_subscriptions。

返回：始终

示例： true

topic_arn

字符串

SNS 主题的 ARN（等同于 sns_arn）。

返回：当主题由此 AWS 账户拥有时

示例： "arn:aws:sns:us-east-2:123456789012:ansible-test-dummy-topic"

topic_type

字符串

主题的类型。

返回：成功

示例： "standard"

作者

  • Alina Buzachis (@alinabuzachis)