community.aws.ssm_parameter 模块 – 管理 AWS Systems Manager Parameter Store 中的键值对

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要满足更多要求才能使用此模块，请参阅 要求 了解详细信息。

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

community.aws 1.0.0 中的新增功能

概要

• 管理 AWS Systems Manager (SSM) Parameter Store 中的键值对。

• 在 5.0.0 版本之前，此模块名为 community.aws.aws_ssm_parameter_store。用法没有改变。

别名：aws_ssm_parameter_store

要求

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

• 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
解密 布尔值	使用 SecureString 类型获取纯文本密钥 选项 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 之后的版本中删除。
key_id 字符串	用于解密密钥的 AWS KMS 密钥。 默认密钥 (alias/aws/ssm) 在首次请求时自动生成。 默认值： "alias/aws/ssm"
name 字符串 / 必需	参数键名称。
overwrite_value 字符串	如果现有值已存在，则覆盖该值的选项。 选项 "never" "changed" ← (默认) "always"
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 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 并且设置了 tags，则会从资源中清除现有标签，以精确匹配 tags 参数的定义。 如果未设置 tags 参数，则不会修改标签，即使 purge_tags=True。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，为了 purge_tags 参数的目的，它们将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
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 之后的版本中删除。
state 字符串	创建或修改现有参数。 删除参数。 选项 "present" ← (默认) "absent"
string_type 别名: type 字符串	参数字符串类型。 选项 "String" ← (默认) "StringList" "SecureString"
tags 别名: resource_tags 字典	一个字典，表示要应用于资源的标签。 如果未设置 tags 参数，则不会修改标签。
tier 字符串 在 community.aws 1.5.0 中添加	参数存储层类型。 选项 "Standard" ← (默认) "Advanced" "Intelligent-Tiering"
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
value 字符串	参数值。

注释

注意

• 在 5.3.0 版本中添加了对 tags 和 purge_tags 的支持。

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

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

另请参阅

另请参阅

amazon.aws.aws_ssm lookup

有关 amazon.aws.aws_ssm 查找插件的文档。

示例

- name: Create or update key/value pair in AWS SSM parameter store
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"

- name: Delete the key
  community.aws.ssm_parameter:
    name: "Hello"
    state: absent

- name: Create or update secure key/value pair with default KMS key (aws/ssm)
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    string_type: "SecureString"
    value: "World"

- name: Create or update secure key/value pair with nominated KMS key
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    string_type: "SecureString"
    key_id: "alias/demo"
    value: "World"

- name: Always update a parameter store value and create a new version
  community.aws.ssm_parameter:
    name: "overwrite_example"
    description: "This example will always overwrite the value"
    string_type: "String"
    value: "Test1234"
    overwrite_value: "always"

- name: Create or update key/value pair in AWS SSM parameter store with tier
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"
    tier: "Advanced"

- name: recommend to use with aws_ssm lookup plugin
  ansible.builtin.debug:
    msg: "{{ lookup('amazon.aws.aws_ssm', 'Hello') }}"

- name: Create or update key/value pair in AWS SSM parameter store w/ tags
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"
    tags:
      Environment: "dev"
      Version: "1.0"
      Confidentiality: "low"
      Tag With Space: "foo bar"

- name: Add or update a tag on an existing parameter w/o removing existing tags
  community.aws.ssm_parameter:
    name: "Hello"
    purge_tags: false
    tags:
      Contact: "person1"

- name: Delete all tags on an existing parameter
  community.aws.ssm_parameter:
    name: "Hello"
    tags: {}

返回值

通用返回值记录在此处，以下是此模块独有的字段

键	描述
parameter_metadata 字典	有关参数的信息。 不包含参数的值，因为这可能是敏感信息。 返回: 成功
data_type 字符串	参数数据类型。 返回: 成功 示例: "text"
描述 字符串	参数键描述。 返回: 成功 示例: "This is your first key"
last_modified_date 字符串	上次修改参数的时间和日期。 返回: 成功 示例: "2022-06-20T09:56:58.573000+00:00"
last_modified_user 字符串	上次修改参数的用户的 ARN。 返回: 成功 示例: "arn:aws:sts::123456789012:assumed-role/example-role/session=example"
name 字符串	参数键名称。 返回: 成功 示例: "Hello"
policies 列表 / 元素=字典	与参数关联的策略列表。 返回: 成功
policy_status 字符串	策略的状态。 返回: 成功 示例: "Pending"
policy_text 字符串	策略的 JSON 文本。 返回: 成功
policy_type 字符串	策略的类型。 返回: 成功 示例: "Expiration"
tags 字典 在 community.aws 5.3.0 中添加	一个字典，表示与参数关联的标签。 返回: 当参数有标签时 示例: {"MyTagName": "Some Value"}
tier 字符串	参数层。 返回: 成功 示例: "Standard"
type 字符串	参数类型 返回: 成功 示例: "String"
version 整数	参数版本号 返回: 成功 示例: 3

作者

• Davinder Pal (@116davinder)

• Nathan Webster (@nathanwebsterdotme)

• Bill Wang (@ozbillwang)

• Michael De La Rue (@mikedlr)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 通信