ansible / ansible.builtin / v2.9.7 / module / ec2_vpc_net Configure AWS virtual private clouds | "added in version" 2.0 of ansible.builtin" Authors: Jonathan Davila (@defionscode), Sloane Hertel (@s-hertel) stableinterface | supported by coreansible.builtin.ec2_vpc_net (v2.9.7) — module
pip
Install with pip install ansible==2.9.7
Create, modify, and terminate AWS virtual private clouds.
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: create a VPC with dedicated tenancy and a couple of tags ec2_vpc_net: name: Module_dev2 cidr_block: 10.10.0.0/16 region: us-east-1 tags: module: ec2_vpc_net this: works tenancy: dedicated
name: description: - The name to give your VPC. This is used in combination with C(cidr_block) to determine if a VPC already exists. required: true tags: aliases: - resource_tags description: - The tags you want attached to the VPC. This is independent of the name value, note if you pass a 'Name' key it would override the Name of the VPC if it's different. state: choices: - present - absent default: present description: - The state of the VPC. Either absent or present. 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 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: - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str tenancy: choices: - default - dedicated default: default description: - Whether to be default or dedicated tenancy. This cannot be changed after the VPC has been created. multi_ok: default: false description: - By default the module will not create another VPC if there is another VPC with the same name and CIDR block. Specify this as true if you want duplicate VPCs created. type: bool 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). type: dict cidr_block: description: - The primary CIDR of the VPC. After 2.5 a list of CIDRs can be provided. The first in the list will be used as the primary CIDR and is used in conjunction with the C(name) to ensure idempotence. required: true dns_support: default: true description: - Whether to enable AWS DNS support. type: bool purge_cidrs: default: false description: - Remove CIDRs that are associated with the VPC and are not specified in C(cidr_block). type: bool version_added: '2.5' version_added_collection: ansible.builtin dhcp_opts_id: description: - the id of the DHCP options to use for this vpc aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path dns_hostnames: default: true description: - Whether to enable AWS hostname support. type: bool 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. - The I(aws_access_key) and I(profile) options are mutually exclusive. 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. - The I(aws_secret_key) and I(profile) options are mutually exclusive. type: str security_token: aliases: - aws_session_token - session_token - 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. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. 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 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
vpc: contains: cidr_block: description: The CIDR of the VPC returned: always sample: 10.0.0.0/16 type: str cidr_block_association_set: description: IPv4 CIDR blocks associated with the VPC returned: success sample: cidr_block_association_set: - association_id: vpc-cidr-assoc-97aeeefd cidr_block: 20.0.0.0/24 cidr_block_state: state: associated type: list classic_link_enabled: description: indicates whether ClassicLink is enabled returned: always sample: null type: NoneType dhcp_options_id: description: the id of the DHCP options associated with this VPC returned: always sample: dopt-0fb8bd6b type: str id: description: VPC resource id returned: always sample: vpc-c2e00da5 type: str instance_tenancy: description: indicates whether VPC uses default or dedicated tenancy returned: always sample: default type: str is_default: description: indicates whether this is the default VPC returned: always sample: false type: bool state: description: state of the VPC returned: always sample: available type: str tags: contains: Name: description: name tag for the VPC returned: always sample: pk_vpc4 type: str description: tags attached to the VPC, includes name returned: always type: complex description: info about the VPC that was created or deleted returned: always type: complex