Try SpotterCreate and delete AWS VPC Endpoints.
| "added in version" 2.4 of ansible.builtin"
Authors: Karen Cheng (@Etherdaemon)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Creates AWS VPC endpoints.
Deletes AWS VPC endpoints.
This module support check mode.
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create new vpc endpoint with a json template for policy
ec2_vpc_endpoint:
state: present
region: ap-southeast-2
vpc_id: vpc-12345678
service: com.amazonaws.ap-southeast-2.s3
policy: " {{ lookup( 'template', 'endpoint_policy.json.j2') }} "
route_table_ids:
- rtb-12345678
- rtb-87654321
register: new_vpc_endpoint
- name: Create new vpc endpoint the default policy
ec2_vpc_endpoint:
state: present
region: ap-southeast-2
vpc_id: vpc-12345678
service: com.amazonaws.ap-southeast-2.s3
route_table_ids:
- rtb-12345678
- rtb-87654321
register: new_vpc_endpoint
- name: Create new vpc endpoint with json file
ec2_vpc_endpoint:
state: present
region: ap-southeast-2
vpc_id: vpc-12345678
service: com.amazonaws.ap-southeast-2.s3
policy_file: "{{ role_path }}/files/endpoint_policy.json"
route_table_ids:
- rtb-12345678
- rtb-87654321
register: new_vpc_endpoint
- name: Delete newly created vpc endpoint
ec2_vpc_endpoint:
state: absent
nat_gateway_id: "{{ new_vpc_endpoint.result['VpcEndpointId'] }}"
region: ap-southeast-2
wait:
default: false
description:
- When specified, will wait for either available status for state present. Unfortunately
this is ignored for delete actions due to a difference in behaviour from AWS.
required: false
type: bool
state:
choices:
- present
- absent
default: present
description:
- present to ensure resource is created.
- absent to remove resource
required: false
policy:
description:
- A properly formatted json policy as string, see U(https://github.com/ansible/ansible/issues/7005#issuecomment-42894813).
Cannot be used with I(policy_file).
- Option when creating an endpoint. If not provided AWS will utilise a default policy
which provides full access to the service.
required: false
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
vpc_id:
description:
- Required when creating a VPC endpoint.
required: false
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
service:
description:
- An AWS supported vpc endpoint service. Use the M(ec2_vpc_endpoint_info) module to
describe the supported endpoint services.
- Required when creating an endpoint.
required: false
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
policy_file:
aliases:
- policy_path
description:
- The path to the properly json formatted policy file, see U(https://github.com/ansible/ansible/issues/7005#issuecomment-42894813)
on how to use it properly. Cannot be used with I(policy).
- Option when creating an endpoint. If not provided AWS will utilise a default policy
which provides full access to the service.
required: false
client_token:
description:
- Optional client token to ensure idempotency
required: false
wait_timeout:
default: 320
description:
- Used in conjunction with wait. Number of seconds to wait for status. Unfortunately
this is ignored for delete actions due to a difference in behaviour from AWS.
required: false
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
route_table_ids:
description:
- List of one or more route table ids to attach to the endpoint. A route is added
to the route table with the destination of the endpoint if provided.
required: false
vpc_endpoint_id:
description:
- One or more vpc endpoint ids to remove from the AWS account
required: false
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
endpoints:
description: The resulting endpoints from the module call
returned: success
sample:
- creation_timestamp: '2017-02-20T05:04:15+00:00'
policy_document:
Id: Policy1450910922815
Statement:
- Action: s3:*
Effect: Allow
Principal: '*'
Resource:
- arn:aws:s3:::*/*
- arn:aws:s3:::*
Sid: Stmt1450910920641
Version: '2012-10-17'
route_table_ids:
- rtb-abcd1234
service_name: com.amazonaws.ap-southeast-2.s3
vpc_endpoint_id: vpce-a1b2c3d4
vpc_id: vpc-abbad0d0
type: list