Class: Ansible::Ruby::Modules::Ec2_vpc_nat_gateway

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb

Overview

Ensure the state of AWS VPC NAT Gateways based on their id, allocation and subnet ids.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#allocation_id ⇒ String?

Returns The id of the elastic IP allocation. If this is not passed and the eip_address is not passed. An EIP is generated for this NAT Gateway.

Returns:

  • (String, nil) —

    The id of the elastic IP allocation. If this is not passed and the eip_address is not passed. An EIP is generated for this NAT Gateway.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 24

attribute :allocation_id

#client_token ⇒ String?

Returns Optional unique token to be used during create to ensure idempotency. When specifying this option, ensure you specify the eip_address parameter as well otherwise any subsequent runs will fail.

Returns:

  • (String, nil) —

    Optional unique token to be used during create to ensure idempotency. When specifying this option, ensure you specify the eip_address parameter as well otherwise any subsequent runs will fail.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 48

attribute :client_token

#eip_address ⇒ String?

Returns The elastic IP address of the EIP you want attached to this NAT Gateway. If this is not passed and the allocation_id is not passed, an EIP is generated for this NAT Gateway.

Returns:

  • (String, nil) —

    The elastic IP address of the EIP you want attached to this NAT Gateway. If this is not passed and the allocation_id is not passed, an EIP is generated for this NAT Gateway.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 28

attribute :eip_address

#if_exist_do_not_create ⇒ Boolean?

Returns if a NAT Gateway exists already in the subnet_id, then do not create a new one.

Returns:

  • (Boolean, nil) —

    if a NAT Gateway exists already in the subnet_id, then do not create a new one.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 32

attribute :if_exist_do_not_create

#nat_gateway_id ⇒ String?

Returns The id AWS dynamically allocates to the NAT Gateway on creation. This is required when the absent option is present.

Returns:

  • (String, nil) —

    The id AWS dynamically allocates to the NAT Gateway on creation. This is required when the absent option is present.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 16

attribute :nat_gateway_id

#release_eip ⇒ String?

Returns Deallocate the EIP from the VPC.,Option is only valid with the absent state.,You should use this with the wait option. Since you can not release an address while a delete operation is happening.

Returns:

  • (String, nil) —

    Deallocate the EIP from the VPC.,Option is only valid with the absent state.,You should use this with the wait option. Since you can not release an address while a delete operation is happening.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 36

attribute :release_eip

#state ⇒ :present, ...

Returns Ensure NAT Gateway is present or absent.

Returns:

  • (:present, :absent, nil) —

    Ensure NAT Gateway is present or absent.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 12

attribute :state

#subnet_id ⇒ String?

Returns The id of the subnet to create the NAT Gateway in. This is required with the present option.

Returns:

  • (String, nil) —

    The id of the subnet to create the NAT Gateway in. This is required with the present option.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 20

attribute :subnet_id

#wait ⇒ String?

Returns Wait for operation to complete before returning.

Returns:

  • (String, nil) —

    Wait for operation to complete before returning.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 40

attribute :wait

#wait_timeout ⇒ Integer?

Returns How many seconds to wait for an operation to complete before timing out.

Returns:

  • (Integer, nil) —

    How many seconds to wait for an operation to complete before timing out.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_nat_gateway.rb', line 44

attribute :wait_timeout