Skip to content

Latest commit

 

History

History
562 lines (522 loc) · 28.8 KB

community.missing_collection.aws_api_gateway_v2_info_module.rst

File metadata and controls

562 lines (522 loc) · 28.8 KB

community.missing_collection.aws_api_gateway_v2_info

Get details about AWS API Gateway V2 Service.

Version added: 0.0.2

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
api_id
string
api id of api gateway v2.
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
domain_name
string
name of the domain used in api gateway v2.
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
get_api
boolean
    Choices:
  • no
  • yes
do you want to fetch details about given api_id?
get_api_mappings
boolean
    Choices:
  • no
  • yes
do you want to fetch api mappings details about given domain_name?
get_deployments
boolean
    Choices:
  • no
  • yes
do you want to fetch deployment details about given api_id?
get_routes
boolean
    Choices:
  • no
  • yes
do you want to fetch routes details about given api_id?
get_stages
boolean
    Choices:
  • no
  • yes
do you want to fetch stages details about given api_id?
get_vpc_links
boolean
    Choices:
  • no
  • yes
do you want to fetch vpc links details?
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: "list of all api gateways"
  aws_api_gateway_v2_info:
  register: _all

- name: "get details about given api id"
  aws_api_gateway_v2_info:
    api_id: "{{ _all.apis[0].api_id }}"
    get_api: true

- name: "get deployments about given api id"
  aws_api_gateway_v2_info:
    api_id: "{{ _all.apis[0].api_id }}"
    get_deployments: true

- name: "get stages about given api id"
  aws_api_gateway_v2_info:
    api_id: "{{ _all.apis[0].api_id }}"
    get_stages: true

- name: "get routes about given api id"
  aws_api_gateway_v2_info:
    api_id: "{{ _all.apis[0].api_id }}"
    get_routes: true

- name: "get api mappings about given domain name"
  aws_api_gateway_v2_info:
    domain_name: "example.com"
    get_api_mappings: true

- name: "get all vpc links"
  aws_api_gateway_v2_info:
    get_vpc_links: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
api
dictionary
when `get_api=true` and `api_id` is defined and success
details about given api id.

Sample:
{'api_endpoint': 'https://feeajf17jg.execute-api.us-east-1.amazonaws.com', 'api_id': 'feeajf17jg', 'api_key_selection_expression': '$request.header.x-api-key', 'created_date': '2020-12-25T12:55:45+00:00', 'disable_execute_api_endpoint': False, 'name': 'test-api', 'protocol_type': 'HTTP', 'response_metadata': {'http_headers': {'connection': 'keep-alive', 'content-length': '376', 'content-type': 'application/json', 'date': 'Fri, 25 Dec 2020 13:25:09 GMT', 'x-amz-apigw-id': 'YHE4aHRwoAMFc-g=', 'x-amzn-requestid': 'xxxxxxxxxx-cdc6b34b07f1', 'x-amzn-trace-id': 'Root=1-xxxxxxxxxxxx4da54a46ce7eb1'}, 'http_status_code': 200, 'request_id': 'xxxxxxxxxx-b6de-cdc6b34b07f1', 'retry_attempts': 0}, 'route_selection_expression': '$request.method $request.path', 'tags': {}}
apis
list
when no argument and success
List of apis.

Sample:
[{'api_endpoint': 'https://feeajf17jg.execute-api.us-east-1.amazonaws.com', 'api_id': 'feeajf17jg', 'api_key_selection_expression': '$request.header.x-api-key', 'created_date': '2020-12-25T12:55:45+00:00', 'disable_execute_api_endpoint': False, 'name': 'test-api', 'protocol_type': 'HTTP', 'route_selection_expression': '$request.method $request.path', 'tags': {}}]
deployments
list
when `get_deployments=true` and `api_id` is defined and success
list of deployments about given api id.

Sample:
[{'auto_deployed': True, 'created_date': 'datetime(2015', 1: None, '1)': None, 'deployment_id': 'string', 'deployment_status': 'DEPLOYED', 'deployment_status_message': 'string', 'description': 'string'}]
mappings
list
when `get_api_mappings=true` and `domain_name` is defined and success
list of mappings about given domain name.

Sample:
[{'api_id': 'string', 'api_mapping_id': 'string', 'api_mapping_key': 'string', 'stage': 'string'}]
routes
list
when `get_routes=true` and `api_id` is defined and success
list of routes about given api id.

Sample:
[{'api_key_required': False, 'authorization_type': 'NONE', 'route_id': 'xxxx', 'route_key': 'ANY /'}]
stages
list
when `get_stages=true` and `api_id` is defined and success
list of stages about given api id.

Sample:
[{'auto_deploy': True, 'created_date': '2020-12-25T12:55:46+00:00', 'default_route_settings': {'detailed_metrics_enabled': False}, 'last_deployment_status_message': 'Deployment attempt failed', 'last_updated_date': '2020-12-25T13:20:09+00:00', 'route_settings': {}, 'stage_name': '$default', 'stage_variables': {}, 'tags': {}}]
vpc_links
list
when `get_vpc_links=true` and success
list of vpc links.

Sample:
[{'created_date': 'datetime(2015', 1: None, '1)': None, 'name': 'string', 'security_group_ids': ['string'], 'subnet_ids': ['string'], 'tags': {'string': 'string'}, 'vpc_link_id': 'string', 'vpc_link_status': 'AVAILABLE', 'vpc_link_status_message': 'string', 'vpc_link_version': 'V2'}]


Status

Authors