New in version 2.2.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
aws_access_key
|
Default:
None
|
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.
aliases: ec2_access_key, access_key |
aws_secret_key
|
Default:
None
|
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.
aliases: ec2_secret_key, secret_key |
bgp_asn
|
Default:
None
|
Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when state=present.
|
ec2_url
|
Default:
None
|
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.
|
ip_address
required |
|
Internet-routable IP address for customers gateway, must be a static address.
|
name
required |
|
Name of the customer gateway.
|
profile
(added in 1.6) |
Default:
None
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
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 |
routing
(added in 2.4) |
|
The type of routing.
|
security_token
(added in 1.6) |
Default:
None
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token |
state
|
|
Create or terminate the Customer Gateway.
|
validate_certs
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Note
# Create Customer Gateway
- ec2_customer_gateway:
bgp_asn: 12345
ip_address: 1.2.3.4
name: IndianapolisOffice
region: us-east-1
register: cgw
# Delete Customer Gateway
- ec2_customer_gateway:
ip_address: 1.2.3.4
name: IndianapolisOffice
state: absent
region: us-east-1
register: cgw
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
gateway.customer_gateways
complex
|
success |
details about the gateway that was created.
|
state
string
|
when gateway exists and is available. |
state of gateway.
|
customer_gateway_id
string
|
when exists and gateway is available. |
gateway id assigned by amazon.
Sample:
cgw-cb6386a2
|
tags
string
|
when gateway exists and is available, and when tags exist. |
any tags on the gateway.
|
type
string
|
when gateway exists and is available. |
encryption type.
Sample:
ipsec.1
|
bgp_asn
string
|
when exists and gateway is available. |
The Border Gateway Autonomous System Number.
Sample:
65123
|
ip_address
string
|
when exists and gateway is available. |
ip address of your gateway device.
Sample:
1.2.3.4
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.