community.aws.glue_connection 模块 – 管理 AWS Glue 连接

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 管理 AWS Glue 连接。有关详细信息，请参阅 https://aws.amazon.com/glue/。

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

别名：aws_glue_connection

要求

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

• 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 之后的一个版本中删除。
availability_zone 字符串 community.aws 1.5.0 中添加	连接使用的可用区 当 connection_type=NETWORK 时必填。
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。
catalog_id 字符串	要在其中创建连接的数据目录的 ID。如果没有提供，则默认使用 AWS 账户 ID。
connection_properties 字典	用作此连接参数的键值对字典。 当 state=present 时必填。
connection_type 字符串	连接的类型。目前不支持 SFTP。 选项 "CUSTOM" "JDBC" ← (默认) "KAFKA" "MARKETPLACE" "MONGODB" "NETWORK"
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 字符串	连接到非默认AWS端点的URL。虽然这可以用于连接到其他兼容AWS的服务，但amazon.aws和community.aws集合只针对AWS进行了测试。 也可以使用AWS_URL或EC2_URL环境变量，优先级依次递减。 ec2_url和s3_url别名已弃用，将在2024-12-01之后的发行版本中移除。 对EC2_URL环境变量的支持已弃用，将在2024-12-01之后的发行版本中移除。
match_criteria 列表 / 元素=字符串	用于指定选择此连接时可使用的条件的UTF-8字符串列表。
name 字符串 / 必填	连接的名称。
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之后的发行版本中移除。
security_groups 列表 / 元素=字符串	连接要使用的安全组列表。使用安全组名称或ID。 当 connection_type=NETWORK 时必填。
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 字符串 / 必填	创建或删除AWS Glue连接。 选项 "present" "absent"
subnet_id 字符串	连接使用的子网ID。 当 connection_type=NETWORK 时必填。
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。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Create an AWS Glue connection
- community.aws.glue_connection:
    name: my-glue-connection
    connection_properties:
      JDBC_CONNECTION_URL: jdbc:mysql://mydb:3306/databasename
      USERNAME: my-username
      PASSWORD: my-password
    state: present

# Create an AWS Glue network connection
- community.aws.glue_connection:
    name: my-glue-network-connection
    availability_zone: us-east-1a
    connection_properties:
      JDBC_ENFORCE_SSL: "false"
    connection_type: NETWORK
    description: Test connection
    security_groups:
      - sg-glue
    subnet_id: subnet-123abc
    state: present

# Delete an AWS Glue connection
- community.aws.glue_connection:
    name: my-glue-connection
    state: absent

返回值

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

Key	描述
connection_type 字符串	连接的类型。 返回：当state为present时 示例："JDBC"
creation_time 字符串	创建此连接定义的时间。 返回：当state为present时 示例："2018-04-21T05:19:58.326000+00:00"
description 字符串	正在定义的作业的描述。 返回：当state为present时 示例："My first Glue job"
last_updated_time 字符串	上次更新此连接定义的时间。 返回：当state为present时 示例："2018-04-21T05:19:58.326000+00:00"
match_criteria 列表 / 元素=字符串	可以选择此连接的一组条件。 返回：当state为present时 示例：[]
name 字符串	连接定义的名称。 返回：当state为present时 示例："my-glue-connection"
physical_connection_requirements 字典	物理连接要求的字典，例如VPC和SecurityGroup，成功建立此连接所需。 返回：当state为present时 示例：{"subnet-id": "subnet-aabbccddee"}
raw_connection_properties 字典	用作此连接参数的键值对字典。 返回：当state为present时 示例：{"JDBC_CONNECTION_URL": "jdbc:mysql://mydb:3306/databasename", "PASSWORD": "y", "USERNAME": "x"}

作者

• Rob White (@wimnat)

集合链接

• 问题跟踪器
• 代码库 (源代码)
• 沟通