1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. ProjectIpAccessList
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

mongodbatlas.ProjectIpAccessList

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

    mongodbatlas.ProjectIpAccessList provides an IP Access List entry resource. The access list grants access from IPs, CIDRs or AWS Security Groups (if VPC Peering is enabled) to clusters within the Project.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    IMPORTANT: When you remove an entry from the access list, existing connections from the removed address(es) may remain open for a variable amount of time. How much time passes before Atlas closes the connection depends on several factors, including how the connection was established, the particular behavior of the application or driver using the address, and the connection protocol (e.g., TCP or UDP). This is particularly important to consider when changing an existing IP address or CIDR block as they cannot be updated via the Provider (comments can however), hence a change will force the destruction and recreation of entries.

    Example Usage

    Using CIDR Block

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.ProjectIpAccessList("test", {
        projectId: "<PROJECT-ID>",
        cidrBlock: "1.2.3.4/32",
        comment: "cidr block for tf acc testing",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.ProjectIpAccessList("test",
        project_id="<PROJECT-ID>",
        cidr_block="1.2.3.4/32",
        comment="cidr block for tf acc testing")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodbatlas.NewProjectIpAccessList(ctx, "test", &mongodbatlas.ProjectIpAccessListArgs{
    			ProjectId: pulumi.String("<PROJECT-ID>"),
    			CidrBlock: pulumi.String("1.2.3.4/32"),
    			Comment:   pulumi.String("cidr block for tf acc testing"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.ProjectIpAccessList("test", new()
        {
            ProjectId = "<PROJECT-ID>",
            CidrBlock = "1.2.3.4/32",
            Comment = "cidr block for tf acc testing",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.ProjectIpAccessList;
    import com.pulumi.mongodbatlas.ProjectIpAccessListArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new ProjectIpAccessList("test", ProjectIpAccessListArgs.builder()
                .projectId("<PROJECT-ID>")
                .cidrBlock("1.2.3.4/32")
                .comment("cidr block for tf acc testing")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:ProjectIpAccessList
        properties:
          projectId: <PROJECT-ID>
          cidrBlock: 1.2.3.4/32
          comment: cidr block for tf acc testing
    

    Using IP Address

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.ProjectIpAccessList("test", {
        projectId: "<PROJECT-ID>",
        ipAddress: "2.3.4.5",
        comment: "ip address for tf acc testing",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.ProjectIpAccessList("test",
        project_id="<PROJECT-ID>",
        ip_address="2.3.4.5",
        comment="ip address for tf acc testing")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodbatlas.NewProjectIpAccessList(ctx, "test", &mongodbatlas.ProjectIpAccessListArgs{
    			ProjectId: pulumi.String("<PROJECT-ID>"),
    			IpAddress: pulumi.String("2.3.4.5"),
    			Comment:   pulumi.String("ip address for tf acc testing"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.ProjectIpAccessList("test", new()
        {
            ProjectId = "<PROJECT-ID>",
            IpAddress = "2.3.4.5",
            Comment = "ip address for tf acc testing",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.ProjectIpAccessList;
    import com.pulumi.mongodbatlas.ProjectIpAccessListArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new ProjectIpAccessList("test", ProjectIpAccessListArgs.builder()
                .projectId("<PROJECT-ID>")
                .ipAddress("2.3.4.5")
                .comment("ip address for tf acc testing")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:ProjectIpAccessList
        properties:
          projectId: <PROJECT-ID>
          ipAddress: 2.3.4.5
          comment: ip address for tf acc testing
    

    Using an AWS Security Group

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.NetworkContainer("test", {
        projectId: "<PROJECT-ID>",
        atlasCidrBlock: "192.168.208.0/21",
        providerName: "AWS",
        regionName: "US_EAST_1",
    });
    const testNetworkPeering = new mongodbatlas.NetworkPeering("test", {
        projectId: "<PROJECT-ID>",
        containerId: test.containerId,
        accepterRegionName: "us-east-1",
        providerName: "AWS",
        routeTableCidrBlock: "172.31.0.0/16",
        vpcId: "vpc-0d93d6f69f1578bd8",
        awsAccountId: "232589400519",
    });
    const testProjectIpAccessList = new mongodbatlas.ProjectIpAccessList("test", {
        projectId: "<PROJECT-ID>",
        awsSecurityGroup: "sg-0026348ec11780bd1",
        comment: "TestAcc for awsSecurityGroup",
    }, {
        dependsOn: [testNetworkPeering],
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.NetworkContainer("test",
        project_id="<PROJECT-ID>",
        atlas_cidr_block="192.168.208.0/21",
        provider_name="AWS",
        region_name="US_EAST_1")
    test_network_peering = mongodbatlas.NetworkPeering("test",
        project_id="<PROJECT-ID>",
        container_id=test.container_id,
        accepter_region_name="us-east-1",
        provider_name="AWS",
        route_table_cidr_block="172.31.0.0/16",
        vpc_id="vpc-0d93d6f69f1578bd8",
        aws_account_id="232589400519")
    test_project_ip_access_list = mongodbatlas.ProjectIpAccessList("test",
        project_id="<PROJECT-ID>",
        aws_security_group="sg-0026348ec11780bd1",
        comment="TestAcc for awsSecurityGroup",
        opts=pulumi.ResourceOptions(depends_on=[test_network_peering]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := mongodbatlas.NewNetworkContainer(ctx, "test", &mongodbatlas.NetworkContainerArgs{
    			ProjectId:      pulumi.String("<PROJECT-ID>"),
    			AtlasCidrBlock: pulumi.String("192.168.208.0/21"),
    			ProviderName:   pulumi.String("AWS"),
    			RegionName:     pulumi.String("US_EAST_1"),
    		})
    		if err != nil {
    			return err
    		}
    		testNetworkPeering, err := mongodbatlas.NewNetworkPeering(ctx, "test", &mongodbatlas.NetworkPeeringArgs{
    			ProjectId:           pulumi.String("<PROJECT-ID>"),
    			ContainerId:         test.ContainerId,
    			AccepterRegionName:  pulumi.String("us-east-1"),
    			ProviderName:        pulumi.String("AWS"),
    			RouteTableCidrBlock: pulumi.String("172.31.0.0/16"),
    			VpcId:               pulumi.String("vpc-0d93d6f69f1578bd8"),
    			AwsAccountId:        pulumi.String("232589400519"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mongodbatlas.NewProjectIpAccessList(ctx, "test", &mongodbatlas.ProjectIpAccessListArgs{
    			ProjectId:        pulumi.String("<PROJECT-ID>"),
    			AwsSecurityGroup: pulumi.String("sg-0026348ec11780bd1"),
    			Comment:          pulumi.String("TestAcc for awsSecurityGroup"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			testNetworkPeering,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.NetworkContainer("test", new()
        {
            ProjectId = "<PROJECT-ID>",
            AtlasCidrBlock = "192.168.208.0/21",
            ProviderName = "AWS",
            RegionName = "US_EAST_1",
        });
    
        var testNetworkPeering = new Mongodbatlas.NetworkPeering("test", new()
        {
            ProjectId = "<PROJECT-ID>",
            ContainerId = test.ContainerId,
            AccepterRegionName = "us-east-1",
            ProviderName = "AWS",
            RouteTableCidrBlock = "172.31.0.0/16",
            VpcId = "vpc-0d93d6f69f1578bd8",
            AwsAccountId = "232589400519",
        });
    
        var testProjectIpAccessList = new Mongodbatlas.ProjectIpAccessList("test", new()
        {
            ProjectId = "<PROJECT-ID>",
            AwsSecurityGroup = "sg-0026348ec11780bd1",
            Comment = "TestAcc for awsSecurityGroup",
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                testNetworkPeering,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.NetworkContainer;
    import com.pulumi.mongodbatlas.NetworkContainerArgs;
    import com.pulumi.mongodbatlas.NetworkPeering;
    import com.pulumi.mongodbatlas.NetworkPeeringArgs;
    import com.pulumi.mongodbatlas.ProjectIpAccessList;
    import com.pulumi.mongodbatlas.ProjectIpAccessListArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new NetworkContainer("test", NetworkContainerArgs.builder()
                .projectId("<PROJECT-ID>")
                .atlasCidrBlock("192.168.208.0/21")
                .providerName("AWS")
                .regionName("US_EAST_1")
                .build());
    
            var testNetworkPeering = new NetworkPeering("testNetworkPeering", NetworkPeeringArgs.builder()
                .projectId("<PROJECT-ID>")
                .containerId(test.containerId())
                .accepterRegionName("us-east-1")
                .providerName("AWS")
                .routeTableCidrBlock("172.31.0.0/16")
                .vpcId("vpc-0d93d6f69f1578bd8")
                .awsAccountId("232589400519")
                .build());
    
            var testProjectIpAccessList = new ProjectIpAccessList("testProjectIpAccessList", ProjectIpAccessListArgs.builder()
                .projectId("<PROJECT-ID>")
                .awsSecurityGroup("sg-0026348ec11780bd1")
                .comment("TestAcc for awsSecurityGroup")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(testNetworkPeering)
                    .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:NetworkContainer
        properties:
          projectId: <PROJECT-ID>
          atlasCidrBlock: 192.168.208.0/21
          providerName: AWS
          regionName: US_EAST_1
      testNetworkPeering:
        type: mongodbatlas:NetworkPeering
        name: test
        properties:
          projectId: <PROJECT-ID>
          containerId: ${test.containerId}
          accepterRegionName: us-east-1
          providerName: AWS
          routeTableCidrBlock: 172.31.0.0/16
          vpcId: vpc-0d93d6f69f1578bd8
          awsAccountId: '232589400519'
      testProjectIpAccessList:
        type: mongodbatlas:ProjectIpAccessList
        name: test
        properties:
          projectId: <PROJECT-ID>
          awsSecurityGroup: sg-0026348ec11780bd1
          comment: TestAcc for awsSecurityGroup
        options:
          dependson:
            - ${testNetworkPeering}
    

    IMPORTANT: In order to use AWS Security Group(s) VPC Peering must be enabled like above example.

    Create ProjectIpAccessList Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProjectIpAccessList(name: string, args: ProjectIpAccessListArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectIpAccessList(resource_name: str,
                            args: ProjectIpAccessListArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectIpAccessList(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project_id: Optional[str] = None,
                            aws_security_group: Optional[str] = None,
                            cidr_block: Optional[str] = None,
                            comment: Optional[str] = None,
                            ip_address: Optional[str] = None,
                            timeouts: Optional[ProjectIpAccessListTimeoutsArgs] = None)
    func NewProjectIpAccessList(ctx *Context, name string, args ProjectIpAccessListArgs, opts ...ResourceOption) (*ProjectIpAccessList, error)
    public ProjectIpAccessList(string name, ProjectIpAccessListArgs args, CustomResourceOptions? opts = null)
    public ProjectIpAccessList(String name, ProjectIpAccessListArgs args)
    public ProjectIpAccessList(String name, ProjectIpAccessListArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:ProjectIpAccessList
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProjectIpAccessListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectIpAccessListArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectIpAccessListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectIpAccessListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectIpAccessListArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var projectIpAccessListResource = new Mongodbatlas.ProjectIpAccessList("projectIpAccessListResource", new()
    {
        ProjectId = "string",
        AwsSecurityGroup = "string",
        CidrBlock = "string",
        Comment = "string",
        IpAddress = "string",
        Timeouts = new Mongodbatlas.Inputs.ProjectIpAccessListTimeoutsArgs
        {
            Delete = "string",
            Read = "string",
        },
    });
    
    example, err := mongodbatlas.NewProjectIpAccessList(ctx, "projectIpAccessListResource", &mongodbatlas.ProjectIpAccessListArgs{
    	ProjectId:        pulumi.String("string"),
    	AwsSecurityGroup: pulumi.String("string"),
    	CidrBlock:        pulumi.String("string"),
    	Comment:          pulumi.String("string"),
    	IpAddress:        pulumi.String("string"),
    	Timeouts: &mongodbatlas.ProjectIpAccessListTimeoutsArgs{
    		Delete: pulumi.String("string"),
    		Read:   pulumi.String("string"),
    	},
    })
    
    var projectIpAccessListResource = new ProjectIpAccessList("projectIpAccessListResource", ProjectIpAccessListArgs.builder()
        .projectId("string")
        .awsSecurityGroup("string")
        .cidrBlock("string")
        .comment("string")
        .ipAddress("string")
        .timeouts(ProjectIpAccessListTimeoutsArgs.builder()
            .delete("string")
            .read("string")
            .build())
        .build());
    
    project_ip_access_list_resource = mongodbatlas.ProjectIpAccessList("projectIpAccessListResource",
        project_id="string",
        aws_security_group="string",
        cidr_block="string",
        comment="string",
        ip_address="string",
        timeouts=mongodbatlas.ProjectIpAccessListTimeoutsArgs(
            delete="string",
            read="string",
        ))
    
    const projectIpAccessListResource = new mongodbatlas.ProjectIpAccessList("projectIpAccessListResource", {
        projectId: "string",
        awsSecurityGroup: "string",
        cidrBlock: "string",
        comment: "string",
        ipAddress: "string",
        timeouts: {
            "delete": "string",
            read: "string",
        },
    });
    
    type: mongodbatlas:ProjectIpAccessList
    properties:
        awsSecurityGroup: string
        cidrBlock: string
        comment: string
        ipAddress: string
        projectId: string
        timeouts:
            delete: string
            read: string
    

    ProjectIpAccessList Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ProjectIpAccessList resource accepts the following input properties:

    ProjectId string
    Unique identifier for the project to which you want to add one or more access list entries.
    AwsSecurityGroup string
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    CidrBlock string
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    Comment string

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    IpAddress string
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    Timeouts ProjectIpAccessListTimeouts
    ProjectId string
    Unique identifier for the project to which you want to add one or more access list entries.
    AwsSecurityGroup string
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    CidrBlock string
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    Comment string

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    IpAddress string
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    Timeouts ProjectIpAccessListTimeoutsArgs
    projectId String
    Unique identifier for the project to which you want to add one or more access list entries.
    awsSecurityGroup String
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidrBlock String
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment String

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ipAddress String
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    timeouts ProjectIpAccessListTimeouts
    projectId string
    Unique identifier for the project to which you want to add one or more access list entries.
    awsSecurityGroup string
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidrBlock string
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment string

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ipAddress string
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    timeouts ProjectIpAccessListTimeouts
    project_id str
    Unique identifier for the project to which you want to add one or more access list entries.
    aws_security_group str
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidr_block str
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment str

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ip_address str
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    timeouts ProjectIpAccessListTimeoutsArgs
    projectId String
    Unique identifier for the project to which you want to add one or more access list entries.
    awsSecurityGroup String
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidrBlock String
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment String

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ipAddress String
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectIpAccessList resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ProjectIpAccessList Resource

    Get an existing ProjectIpAccessList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProjectIpAccessListState, opts?: CustomResourceOptions): ProjectIpAccessList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aws_security_group: Optional[str] = None,
            cidr_block: Optional[str] = None,
            comment: Optional[str] = None,
            ip_address: Optional[str] = None,
            project_id: Optional[str] = None,
            timeouts: Optional[ProjectIpAccessListTimeoutsArgs] = None) -> ProjectIpAccessList
    func GetProjectIpAccessList(ctx *Context, name string, id IDInput, state *ProjectIpAccessListState, opts ...ResourceOption) (*ProjectIpAccessList, error)
    public static ProjectIpAccessList Get(string name, Input<string> id, ProjectIpAccessListState? state, CustomResourceOptions? opts = null)
    public static ProjectIpAccessList get(String name, Output<String> id, ProjectIpAccessListState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AwsSecurityGroup string
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    CidrBlock string
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    Comment string

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    IpAddress string
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    ProjectId string
    Unique identifier for the project to which you want to add one or more access list entries.
    Timeouts ProjectIpAccessListTimeouts
    AwsSecurityGroup string
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    CidrBlock string
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    Comment string

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    IpAddress string
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    ProjectId string
    Unique identifier for the project to which you want to add one or more access list entries.
    Timeouts ProjectIpAccessListTimeoutsArgs
    awsSecurityGroup String
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidrBlock String
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment String

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ipAddress String
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    projectId String
    Unique identifier for the project to which you want to add one or more access list entries.
    timeouts ProjectIpAccessListTimeouts
    awsSecurityGroup string
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidrBlock string
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment string

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ipAddress string
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    projectId string
    Unique identifier for the project to which you want to add one or more access list entries.
    timeouts ProjectIpAccessListTimeouts
    aws_security_group str
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidr_block str
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment str

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ip_address str
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    project_id str
    Unique identifier for the project to which you want to add one or more access list entries.
    timeouts ProjectIpAccessListTimeoutsArgs
    awsSecurityGroup String
    Unique identifier of the AWS security group to add to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    cidrBlock String
    Range of IP addresses in CIDR notation to be added to the access list. Your access list entry can include only one awsSecurityGroup, one cidrBlock, or one ipAddress.
    comment String

    Comment to add to the access list entry.

    NOTE: One of the following attributes must set: aws_security_group, cidr_block or ip_address.

    ipAddress String
    Single IP address to be added to the access list. Mutually exclusive with awsSecurityGroup and cidrBlock.
    projectId String
    Unique identifier for the project to which you want to add one or more access list entries.
    timeouts Property Map

    Supporting Types

    ProjectIpAccessListTimeouts, ProjectIpAccessListTimeoutsArgs

    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

    Import

    IP Access List entries can be imported using the project_id and cidr_block or ip_address, e.g.

    $ pulumi import mongodbatlas:index/projectIpAccessList:ProjectIpAccessList test 5d0f1f74cf09a29120e123cd-10.242.88.0/21
    

    For more information see: MongoDB Atlas API Reference.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi