Learn Idem

Learn Idem

Powered by Idem Project

aws.ec2.internet_gateway

**Autogenerated function**

Deletes the specified internet gateway. If resource is attached to VPC. then it is detached first and then deleted.

Args:
    name(Text): An Idem name to identify the internet gateway resource.
    resource_id(Text, optional): AWS Internet Gateway ID.

Request Syntax:
    [internet_gateway-name]:
      aws.ec2.internet_gateway.absent:
      - name: 'string'
      - resource_id: 'string'

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

       igw-test:
        aws.ec2.internet_gateway.absent:
          - name: igw-test
          - resource_id: '12345678'
**Autogenerated function**

Describe the resource in a way that can be recreated/managed with the corresponding "present" function

Describes one or more of your internet gateways.


Returns:
    Dict[str, Any]

Examples:

    .. code-block:: bash

        $ idem describe aws.ec2.internet_gateway
**Autogenerated function**

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC
using AttachInternetGateway. For more information about your VPC and internet gateway, see the Amazon Virtual
Private Cloud User Guide.

Args:
    name(Text): An Idem name to identify the internet gateway resource.
    resource_id(Text, optional): AWS Internet Gateway ID.
    tags(Dict or List, optional): Dict in the format of {tag-key: tag-value} or List of tags in the format of
        [{"Key": tag-key, "Value": tag-value}] to associate with the internet gateway resource. Defaults to None.
        * (Key, optional): The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode
            characters. May not begin with aws:.
        * (Value, optional): The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256
            Unicode characters.
    vpc_id(List, optional): This list can contain only single element. This is ID of VPC to which internet gateway attaches.
    If vpc_id is not passed, then attach/detach operation is ignored.
    If user passes empty list, then attached vpc is detached.

Request Syntax:
    [internet_gateway-name]:
      aws.ec2.internet_gateway.present:
      - vpc_id:
        - 'string'
      - tags:
        - Key: 'string'
          Value: 'string'
Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        test-igw:
         aws.ec2.internet_gateway.present:
         - vpc_id:
           - vpc-d04fbf46
         - tags:
           - Key: Name
             Value: test-igw

Full plugin documentation is available on the Idem documentation site - aws.ec2.internet_gateway .

Last updated on 20 Sep 2022
 Edit on GitHub